You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Tobias Fiebig d77d6d6fcb Changed default SMTP sender address to noreply@example.com 3 years ago
bin migration: Prevent parallel migration runs 4 years ago
config Changed default SMTP sender address to noreply@example.com 3 years ago
db Fix migration and test improvements 3 years ago
docker More PHP 8.1 fixes to be compatible 3 years ago
includes closes #877: sequential numbers for arrived angels view 3 years ago
public Moved emojis to assets 6 years ago
resources closes #877: sequential numbers for arrived angels view 3 years ago
src Make password enabled configurable via oauth settings 3 years ago
storage storage/: .gitignore fixups 5 years ago
tests Make password enabled configurable via oauth settings 3 years ago
.babelrc Use core-js as polyfill to really support older browsers. 5 years ago
.browserslistrc Use core-js as polyfill to really support older browsers. 5 years ago
.dockerignore Use more configs from env, improved docker setup 4 years ago
.editorconfig chore: update webpack to v5 (and related deps) 3 years ago
.gitignore Removed and replaced outdated classes and styling, use secondary buttons 3 years ago
.gitlab-ci.yml CI: Fixed environment name confusion 3 years ago
.phpcs.xml Add phpcs config file 5 years ago
CONTRIBUTING.md introduce PostCSS + Autoprefixer 4 years ago
DEVELOPMENT.md dev docs: fixed container name 3 years ago
LICENSE directory renames and cleanup 14 years ago
README.md make all themes basically working with bs5 3 years ago
composer.json Remain PHP 7.4 compatible 3 years ago
composer.lock Bump twig/twig from 3.3.4 to 3.3.8 3 years ago
deployment.tpl.yaml k8s: Use stable ingress definition 3 years ago
package.json remove unused file-loader 3 years ago
phpunit.xml PHPUnit: Upgraded phpunit and config file format 4 years ago
webpack.config.js update major devDeps and minor prodDeps 3 years ago
yarn.lock remove unused file-loader 3 years ago

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, 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