diff --git a/README.md b/README.md index 344db15..bd52972 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,40 @@ -# Voraussetzungen -## Apache Moduls: -* php-rewrite +# Requirements + +## Apache Modules: +* mod-rewrite + ## Packages * php7 * php7-mysql -# Beispiel Apache Config +# Sample Apache Config ```apache - ServerAdmin webmaster@localhost + ServerAdmin webmaster@localhost + ServerName shopping.example.com - DocumentRoot /var/www/html/shopping-list - - AllowOverride All - + DocumentRoot /var/www/html/shopping-list + - ErrorLog ${APACHE_LOG_DIR}/error.log - CustomLog ${APACHE_LOG_DIR}/access.log combined + AllowOverride All + + + ErrorLog ${APACHE_LOG_DIR}/error.log + CustomLog ${APACHE_LOG_DIR}/access.log combined ``` -# Installation -Um die Installation zu starten folgende Seite aufrufen: -[HOSTNAME]/install/install.php + +# Installation Instructions + +* create a new mysql-database. Please use `utf8_general_ci` as your collation. +* create a new mysql-user that can edit the database. + +* Download the latest release. You can download it [here (tar.gz)](https://gitlab.com/bluekay/shopping-list/-/archive/master/shopping-list-master.tar.gz) or [here (zip)](https://gitlab.com/bluekay/shopping-list/-/archive/master/shopping-list-master.zip) +* unpack the archive and copy its content to `/var/www/html/shopping-list` +* grant your web server permission to write the config-file +```bash +chown www-data:www-data /var/www/html/shopping-list/config/config.php +``` +* visit the address of your web browser, you will be redirected to the installation page +* insert your database information and create your login user +* thats it, you are good to go. You may login now!