Please visit engelsystem.de for a feature list.

To report bugs use engelsystem/issues.

Since the Engelsystem is open source, you can help improving it. We really love to get pull requests containing fixes or improvements. Please read the CONTRIBUTING.md and DEVELOPMENT.md before you start.

The Engelsystem may be installed manually or by using the provided docker setup.

• PHP >= 7.3
  • Required modules:
    • dom
    • json
    • mbstring
    • PDO
      • mysql
    • tokenizer
    • xml/libxml/SimpleXML
    • xmlwriter
• MySQL-Server >= 5.7.8 or MariaDB-Server >= 10.2.2
• Webserver, i.e. lighttpd, nginx, or Apache

• Go to the Releases page and download the latest stable release file.
• Extract the files to your webroot and continue with the directions for configurations and setup.

• The webserver must have write access to the storage directory and read access for all other directories

• The webserver must point to the public directory.

• The webserver must read the .htaccess file and mod_rewrite must 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.

• If necessary, create a config/config.php to override values from config/config.default.php.

  • To remove values from the footer_items, available_themes, locales, tshirt_sizes or headers lists the config file has to be renamed.

• To import the database the bin/migrate script has to be called. If you are not allowed to execute scripts, then execute the install-<version>.sql script. Download at Releases page.

• In the browser, login with credentials admin : asdfasdf and change the password.

The Engelsystem can now be used.

• Make sure the config allows for sessions.
• Both Apache and Nginx allow for different VirtualHost configurations.

To build the es_nginx and the es_php_fpm containers:

cd docker
docker-compose build

or to build the containers separately

docker build -f docker/nginx/Dockerfile . -t es_nginx
docker build -f docker/Dockerfile . -t es_php_fpm

Start the Engelsystem

cd docker
docker-compose up -d

Import database changes to migrate it to the newest version

docker exec -it engelsystem_es_php_fpm_1 bin/migrate

The bin/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 ./bin/deploy.sh -h

The bin/migrate script can be used to import and update the database of the Engelsystem.

For more information on how to use it call ./bin/migrate help