iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
2,658 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 74be132f47 Improve `/design`: Add section links and disable in-text-links 2022-10-22 20:31:41 +02:00
bin migration: Prevent parallel migration runs 2020-06-28 19:31:17 +02:00
config make session lifetime configurable 2022-10-21 19:42:10 +02:00
db Groups: Fix naming and update IDs 2022-10-22 17:49:20 +02:00
docker k8s: Use traefik as default ingress, added improved app url handling to support subpath deployments 2022-10-14 13:36:11 +02:00
includes Groups: Fix naming and update IDs 2022-10-22 17:49:20 +02:00
public Moved emojis to assets 2018-09-10 22:49:46 +02:00
resources Improve `/design`: Add section links and disable in-text-links 2022-10-22 20:31:41 +02:00
src Groups: Fix naming and update IDs 2022-10-22 17:49:20 +02:00
storage storage/: .gitignore fixups 2019-10-06 17:11:06 +02:00
tests Groups: Fix naming and update IDs 2022-10-22 17:49:20 +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
.dockerignore Docker: Use single container for server 2022-04-29 20:22:08 +02:00
.editorconfig chore: update webpack to v5 (and related deps) 2021-05-22 17:04:39 +02:00
.gitignore Removed and replaced outdated classes and styling, use secondary buttons 2021-07-29 20:01:19 +02:00
.gitlab-ci.yml k8s: Use traefik as default ingress, added improved app url handling to support subpath deployments 2022-10-14 13:36:11 +02:00
.phpcs.xml Include phpcs for /includes 2022-10-18 19:15:22 +02:00
CONTRIBUTING.md Updated contributing guidelines 2022-10-14 16:46:03 +02:00
DEVELOPMENT.md Require @covers annotation for tests, increase workspace mem limit to 512M, improved coverage for db factories 2022-06-02 13:18:37 +02:00
LICENSE directory renames and cleanup 2011-06-11 18:08:56 +02:00
README.md Remove codacy badge 2022-07-15 15:17:30 +02:00
composer.json Update twig 2022-10-01 19:30:14 +02:00
composer.lock Fixed composer.lock hash 2022-10-01 19:41:43 +02:00
deployment.tpl.yaml k8s: Use traefik as default ingress, added improved app url handling to support subpath deployments 2022-10-14 13:36:11 +02:00
package.json Remove moment 2022-10-22 17:22:59 +02:00
phpunit.xml Require @covers annotation for tests, increase workspace mem limit to 512M, improved coverage for db factories 2022-06-02 13:18:37 +02:00
webpack.config.js Added assets hashing after build, added favicon 2022-04-29 22:26:58 +02:00
yarn.lock Remove moment 2022-10-22 17:22:59 +02:00

README.md

pipeline status coverage report 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.4
    • 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 edit values from the footer_items, themes, locales, tshirt_sizes or headers lists, directly modify the config/config.default.php file or rename it to config/config.php.

  • 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_server container:

cd docker
docker-compose build

or to build the container by its own:

docker build -f docker/Dockerfile . -t es_server

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

Documentation

More documentation can be found at: https://engelsystem.de/doc/