Go to file
Igor Scheller ff8adafd33 Added more factories
bin migration: Prevent parallel migration runs
config Set initial admin password if configured
db Added more factories
docker CI: Use kaniko to build images
includes how to mark angels as active
public Moved emojis to assets
resources Fixed shift time shortcuts not updating date select
src Added more factories
storage storage/: .gitignore fixups
tests Added more factories
.babelrc Use core-js as polyfill to really support older browsers.
.browserslistrc Use core-js as polyfill to really support older browsers.
.dockerignore Use more configs from env, improved docker setup
.editorconfig chore: update webpack to v5 (and related deps)
.gitignore Introduce composer.lock file
.gitlab-ci.yml CI: Use kaniko to build images
.phpcs.xml Add phpcs config file
CONTRIBUTING.md introduce PostCSS + Autoprefixer
DEVELOPMENT.md Replaced master branch with main in readmes
LICENSE directory renames and cleanup
README.md Replaced master branch with main in readmes
composer.json Added user related factories
composer.lock Added user related factories
deployment.tpl.yaml k8s: Use stable ingress definition
package.json Removed postcss-preset-env for good as its job is already done by autoprefixer & package upgrades
phpunit.xml PHPUnit: Upgraded phpunit and config file format
webpack.config.js Removed postcss-preset-env for good as its job is already done by autoprefixer & package upgrades
yarn.lock Upgrade css-what and its dependencies

README.md

pipeline status coverage report Codacy Badge GPL

Engelsystem

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.

Installation

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

Requirements

  • 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

Download

  • 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.

Configuration 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 be a MySQL database set up 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 run. If you can't execute scripts, you can use the initial-install.sql file from the release zip.

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

The Engelsystem can now be used.

Session Settings

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

Docker

Build

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

Run

Start the Engelsystem

cd docker
docker-compose up -d

Migrate

Import database changes to migrate it to the newest version

cd docker
docker-compose exec es_php_fpm bin/migrate

Scripts

bin/deploy.sh

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

bin/migrate

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