iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
2,295 Commits 4 Branches 0 Tags 22 MiB
PHP 86.9%
Twig 8.4%
SCSS 3.3%
JavaScript 0.8%
HTML 0.3%
Other 0.3%
Go to file
Igor Scheller e4247cd0bd Metrics: Use buckets for work, worklog and vouchers 2020-09-22 11:37:21 +02:00
bin migration: Prevent parallel migration runs 2020-06-28 19:31:17 +02:00
config Metrics: Use buckets for work, worklog and vouchers 2020-09-22 11:37:21 +02:00
db File formatting fixes 2020-06-28 19:39:29 +02:00
docker chore: update dependencies, remove imports-loader 2020-09-01 11:17:05 +02:00
includes Add option for minutes after shift start where signup is allowed 2020-09-02 13:12:16 +02:00
public Moved emojis to assets 2018-09-10 22:49:46 +02:00
resources chore: update dependencies, remove imports-loader 2020-09-01 11:17:05 +02:00
src Metrics: Use buckets for work, worklog and vouchers 2020-09-22 11:37:21 +02:00
storage storage/: .gitignore fixups 2019-10-06 17:11:06 +02:00
tests Metrics: Use buckets for work, worklog and vouchers 2020-09-22 11:37:21 +02:00
.babelrc Use core-js as polyfill to really support older browsers. 2019-07-26 12:40:21 +02:00
.browserslistrc Use core-js as polyfill to really support older browsers. 2019-07-26 12:40:21 +02:00
.editorconfig .editorconfig: Fixed max_line_length 2020-06-28 19:39:29 +02:00
.gitignore Adds a docker dev setup 2019-10-27 08:57:56 +01:00
.gitlab-ci.yml CI: Added .editorconfig linting 2020-06-28 19:39:29 +02:00
.phpcs.xml Add phpcs config file 2019-11-13 01:07:02 +01:00
CONTRIBUTING.md CI: Added .editorconfig linting 2020-06-28 19:39:29 +02:00
DEVELOPMENT.md chore: update node version to 14 2020-09-01 10:55:53 +02:00
LICENSE directory renames and cleanup 2011-06-11 18:08:56 +02:00
README.md Clarified docker-compose in readme 2020-08-08 20:54:48 +02:00
composer.json Fixed Symfony 5.1 compatibility 2020-06-01 13:31:16 +02:00
deployment.tpl.yaml CI: Add k8s deployment 2020-06-28 19:31:17 +02:00
package.json chore: update dependencies, remove imports-loader 2020-09-01 11:17:05 +02:00
phpunit.xml More .editorconfig improvements 2020-06-28 19:39:29 +02:00
webpack.config.js add 36c3 theme 2019-11-23 18:39:09 +01:00
yarn.lock chore: update dependencies, remove imports-loader 2020-09-01 11:17:05 +02:00

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

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

docker exec -it engelsystem_es_php_fpm_1 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