Please visit https://engelsystem.de for a feature list.
To report bugs use engelsystem/issues
- PHP >= 7.0
- MySQL-Server >= 5.5 or MariaDB-Server >= 5.5
- Webserver, i.e. lighttpd, nginx, or Apache
- Node >= 8 (Development/Building only)
- Yarn (Development/Building only)
Clone the master branch:
git clone https://github.com/engelsystem/engelsystem.git
Install project dependencies:
composer install yarn
On production systems it is recommended to use
composer install --no-dev composer dump-autoload --optimize
to install the engelsystem
Build the frontend assets
The webserver must have write access to the
importdirectory and read access for all other directories
The webserver must point to the
The webserver must read the
mod_rewritemust be enabled
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
If necessary, create a
config/config.phpto override values from
In the browser, login with credentials
asdfasdfand change the password.
Engelsystem can now be used.
- Make sure the config allows for sessions.
- Both Apache and Nginx allow for different VirtualHost configurations.
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.
To run the unit tests use
vendor/bin/phpunit --testsuite Unit
If a database is configured and the engelsystem is allowed to mess around with some files, you can run feature tests. The tests can potentially delete some database entries, so they should never be run on a production system!
vendor/bin/phpunit --testsuite Feature # or for unit- and feature tests: vendor/bin/phpunit
CI & Build Pipeline
The engelsystem can be tested and automatically deployed to a testing/staging/production environment. This functionality requires a GitLab server with a running docker minion.
To use the deployment features the following secret variables need to be defined (if undefined the step will be skipped):
SSH_PRIVATE_KEY # The ssh private key STAGING_REMOTE # The staging server, e.g. firstname.lastname@example.org STAGING_REMOTE_PATH # The path on the remote server, e.g. /var/www/engelsystem PRODUCTION_REMOTE # Same as STAGING_REMOTE but for the production environment PRODUCTION_REMOTE_PATH # Same as STAGING_REMOTE_PATH but for the production environment
deploy.sh script can be used to deploy the engelsystem. It uses rsync to deploy the application to a server over ssh.
For usage see