Go to file
Igor Scheller 8a9031fa01 Docker: Added storage path to container
Closes #505
2018-12-02 12:29:48 +01:00
bin Fixups and cleanup for GitLab CI 2018-09-03 22:09:07 +02:00
config Added additional headers 2018-11-21 19:24:36 +01:00
contrib Docker: Added storage path to container 2018-12-02 12:29:48 +01:00
db User: Bugfixes & code cleanup 2018-10-31 13:43:23 +01:00
import camp 2011 export 2011-07-14 19:53:19 +02:00
includes more work on 35c3 theme 2018-11-25 15:40:53 +01:00
public Moved emojis to assets 2018-09-10 22:49:46 +02:00
resources more work on 35c3 theme 2018-11-25 15:40:53 +01:00
src Added caching for templating and routing 2018-11-24 16:30:36 +01:00
storage/cache Added caching for templating and routing 2018-11-24 16:30:36 +01:00
tests Added caching for templating and routing 2018-11-24 16:30:36 +01:00
.babelrc frontend stuff with babel and webpack 2018-01-03 01:19:31 +01:00
.gitignore Added junit xml export artifacts for GitLab CI 2018-09-26 21:17:11 +02:00
.gitlab-ci.yml gitlab-ci: fix proxy container naming 2018-10-24 19:15:52 +02:00
LICENSE directory renames and cleanup 2011-06-11 18:08:56 +02:00
README.md Update needed directory permissions in README 2018-11-24 16:30:36 +01:00
composer.json Readme: Bump versions and fix formatting 2018-10-24 19:16:47 +02:00
package.json Moved scripts/copyAssets.js to resources folder and fixed formatting 2018-09-10 22:49:51 +02:00
phpunit.xml Merge branch 'noc0lour:fix_setup_bugs', closes #335 2017-10-31 13:41:17 +01:00
webpack.config.js add 35c3 theme dark 2018-11-11 20:50:25 +01:00

README.md

Codacy Badge GPL

Engelsystem

Please visit https://engelsystem.de for a feature list.

To report bugs use engelsystem/issues

Installation

Requirements:

  • PHP >= 7.1
    • Required modules:
      • gettext
      • json
      • PDO
      • xml/libxml/SimpleXML
  • MySQL-Server >= 5.7.8 or MariaDB-Server >= 10.2.2
  • Webserver, i.e. lighttpd, nginx, or Apache
  • Node >= 8 (Development/Building only)
  • Yarn (Development/Building only)

Directions:

  • Clone the master branch: git clone https://github.com/engelsystem/engelsystem.git

  • Install Composer and Yarn (which requires Node.js)

  • Install project dependencies:

    composer install
    yarn
    

    On production systems it is recommended to use

    composer install --no-dev
    composer dump-autoload --optimize
    

    to install the engelsystem

  • Build the frontend assets

    yarn build
    
  • The webserver must have write access to the import and storage directories 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.

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

Engelsystem can now be used.

Session Settings:

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

Development

Since the engelsystem is open source, you can help to improve the system. We really love to get pull requests containing fixes or implementations of our Github issues.

Please create single pull requests for every feature instead of creating one big monster of pull request containing a complete rewrite.

Testing

To run the unit tests use

vendor/bin/phpunit --testsuite Unit

If a database is configured and the engelsystem is allowed to mess around with some files, you can run feature tests. The tests can potentially delete some database entries, so they should never be run on a production system!

vendor/bin/phpunit --testsuite Feature
# or for unit- and feature tests:
vendor/bin/phpunit

CI & Build Pipeline

The engelsystem can be tested and automatically deployed to a testing/staging/production environment. This functionality requires a GitLab server with a running docker minion.

To use the deployment features the following secret variables need to be defined (if undefined the step will be skipped):

SSH_PRIVATE_KEY         # The ssh private key
STAGING_REMOTE          # The staging server, e.g. user@remote.host
STAGING_REMOTE_PATH     # The path on the remote server, e.g. /var/www/engelsystem
PRODUCTION_REMOTE       # Same as STAGING_REMOTE but for the production environment
PRODUCTION_REMOTE_PATH  # Same as STAGING_REMOTE_PATH but for the production environment

Docker container

To build the engelsystem and the engelsystem-nginx container:

cd contrib
docker-compose build

or to build the containers separately

docker build -f contrib/nginx/Dockerfile . -t engelsystem-nginx
docker build -f contrib/Dockerfile . -t engelsystem

Import database

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

Codestyle

Please ensure that your pull requests follow PSR-2 and PSR-4.