diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 31 insertions, 19 deletions
@@ -1,30 +1,42 @@ [](https://www.codacy.com/app/engelsystem/engelsystem) []() -# Installation eines frischen Engelsystems +# Engelsystem -## Mindestvorrausetzungen (bzw. getestet unter): +Please visit https://engelsystem.de for a feature list. + +## Installation + +### Requirements: * PHP 5.4.x (cgi-fcgi) * MySQL-Server 5.5.x - * Webserver mit PHP-Anbindung, z.B. lighttpd, nginx oder Apache + * Webserver, i.e. lighttpd, nginx, or Apache + +### Directions: + * Clone the master branch: `git clone https://github.com/engelsystem/engelsystem.git` + * Install [Composer](https://getcomposer.org/download/) + * Install project dependencies: `composer install` + * Webserver must have write access to the 'import' directory and read access for all other directories + * Webserver must be public. + + * Recommended: Directory Listing should be disabled. + * There must a be MySQL database created with a user who has full rights to that database. + * It must be created by the db/install.sql and db/update.sql files. + * If necessary, create a config/config.php to override values from config/config.default.php. + * In the browser, login with credentials admin:asdfasdf and change the password. + +Engelsystem can now be used. -## Vorgehen: - * Klonen des `master` in lokales Verzeichnis: `git clone https://github.com/engelsystem/engelsystem.git` - * [Composer](https://getcomposer.org/download/) installieren - * Abhängigkeiten installieren: `composer install` - * Der Webserver muss Schreibrechte auf das Verzeichnis `import` bekommen, für alle anderen Dateien reichen Leserechte. - * Der Webserver muss auf `public` als http-root zeigen. +### Session Settings: + * Make sure the config allows for sessions. + * Both Apache and Nginx allow for different VirtualHost configurations. - * Empfehlung: Dirlisting sollte deaktiviert sein. - * Es muss eine MySQL-Datenbank angelegt werden und ein User existieren, der alle Rechte auf dieser Datenbank besitzt. - * Es muss die db/install.sql und die db/update.sql importiert/ausgeführt werden. - * Erstelle bei Bedarf eine config/config.php, die die Werte (z.B. DB-Zugang) aus der config/config.default.php überschreibt. - * Engelsystem im Browser aufrufen, Anmeldung mit admin:asdfasdf vornehmen und Admin-Passwort ändern. +Report Bugs: https://github.com/engelsystem/engelsystem/issues -Das Engelsystem ist jetzt einsatzbereit. +## Development +Since the engelsystem is open source, you can help to improve the system. We really love to get pull requests containing fixes or implementations of our Github issues. -## Session Einstellungen: - * Einstellungen für Cookies und Sessions bitte in der PHP Config des Servers vornehmen. - * Sowohl Apache als auch nginx bieten Möglichkeiten für verschiedene Konfigurationen pro VirtualHost an +Please create single pull requests for every feature instead of creating one big monster of pull request containing a complete rewrite. -Fehler bitte auf Github melden: https://github.com/engelsystem/engelsystem/issues +### Codestyle +Please ensure that your pull requests follow [PSR-2](http://www.php-fig.org/psr/psr-2/) and [PSR-4](http://www.php-fig.org/psr/psr-4/). |