diff options
author | msquare <msquare@notrademark.de> | 2017-11-28 15:43:51 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-11-28 15:43:51 +0100 |
commit | 599f2fd264bfc7b1b6826fe206442806e317340f (patch) | |
tree | 50cf84d7d07d11bd65b45c2c17f37632f6cd8eff /README.md | |
parent | a5fc5bd0979e8de1fce8a8addd351a6e7bd6aeb8 (diff) | |
parent | eda7f7788ea8012bd8be46405c56a666c11f3fa5 (diff) |
Merge pull request #365 from engelsystem/feature-igel-rewrite
Feature igel rewrite
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 52 |
1 files changed, 33 insertions, 19 deletions
@@ -1,28 +1,42 @@ [![Codacy Badge](https://api.codacy.com/project/badge/Grade/20b3b0b4e93344a29da6bec77f329e7a)](https://www.codacy.com/app/engelsystem/engelsystem) [![GPL](https://img.shields.io/github/license/engelsystem/engelsystem.svg?maxAge=2592000)]() -# Installation eines frischen Engelsystems +# Engelsystem -## Mindestvorrausetzungen (bzw. getestet unter): - * PHP 5.4.x (cgi-fcgi) - * MySQL-Server 5.5.x - * Webserver mit PHP-Anbindung, z.B. lighttpd, nginx oder Apache +Please visit https://engelsystem.de for a feature list. -## Vorgehen: - * Klonen des `master` inkl. submodules in lokales Verzeichnis: `git clone --recursive https://github.com/engelsystem/engelsystem.git` - * 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. +## Installation - * 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. +### Requirements: + * PHP >= 7.0.0 + * MySQL-Server >= 5.5.x + * Webserver, i.e. lighttpd, nginx, or Apache -Das Engelsystem ist jetzt einsatzbereit. +### 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 point to the public directory. -## 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 + * 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. -Fehler bitte auf Github melden: https://github.com/engelsystem/engelsystem/issues +Engelsystem can now be used. + +### Session Settings: + * Make sure the config allows for sessions. + * Both Apache and Nginx allow for different VirtualHost configurations. + +Report Bugs: https://github.com/engelsystem/engelsystem/issues + +## 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. + +Please create single pull requests for every feature instead of creating one big monster of pull request containing a complete rewrite. + +### 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/). |