README.md

# Registration tool for Events: Regi

Regi is designed to manage attendees of local events:

  - supports different locations with multiple rooms and individual capacity
  - all events must fit into predefined time slots
  - each event has a title, presenter, description and a time slot and location.
  - it is possible to configure confirmation emails (requries a local mail server)
  - booking process will store phone and email contact information
  - supports DSGVO informations for users
  - licensed under AGPL 3.0, see LICENSE for further details

## Getting started

### Quick-Start (just for trying on your local machine)

WARNING, this is not intended for production use!

   * check out code: `git clone https://github.molgen.mpg.de/cbs/regi.git`
   * create a new virtual environment with: `mkvirtualenv -p /usr/bin/python3 regi`. (If mkvirtualenv command is not available on your system, you may install the virtualenvwrapper package)
   * `cd regi`
   * `pip install -e .`
   * prepare to start: `make migrate && make createsuperuser`
   * run the server: `make`

### Production use

To run the application you can either use the docker-compose file or you run the application with Python.
For the latter case you need a Python3 environment and have to intstall the dependencies with `setup.py`.
If you choose to run as a docker container (we recommend this), you are required to have installed docker (see https://docs.docker.com/install/) and docker-compose (see https://docs.docker.com/compose/install/).

#### Database

You need to tell the tool the password for the database.
It's defined by the environment variable POSTGRES_PASSWORD.
Then you can run the database by calling `docker-compose up [-d] postgres`.
If the database is running, you're required to run the migrations by calling `docker-compose up migration`.

#### Run the service

You should only start the nginx, to not rerun the initial_data container: `docker-compose up -d nginx`

## Configuration

### Custom adapations (e.g. text)

Some of the registration-event text is scattered within the code, so you need to rebuild the docker image once you change it.

   * Please lookout for strings "Leipzig" and Dates "2018", especially within all template files, which are also the most proper place to paste your custom HTML code and content.
      * `regi/regi/templates/*`
      * `regi/registration/templates/registration/*`
   * Please lookout for emails hardcoded within the source, e.g. `mpt2018@cbs.mpg.de` in `regi/registration/views.py`
   * DSGVO infos reside within: `regi/templates/base.html`
   * most settings are located in `regi/regi/settings.py`

### EMail setting

To allow the tool to send EMails you need to specify a local email server within the settings.py.

```
EMAIL_HOST = 'yourmail.server.mpg.de'
EMAIL_PORT = 25
EMAIL_SUBJECT_PREFIX = '[MPT2018]'
```

together with:

```
ADMINS = [('Mathias Goldau', 'goldau@cbs.mpg.de')]
SERVER_EMAIL = 'regi@mpt2018.cbs.mpg.de'
```

Please do not forget to rebuild docker image after adaption.

### HTTPS

The nginx configuration requires two certificate files: `cert.pem` and `key.pem`. You can see in the configuration file where they must live. If you want to use the nginx docker container you just have to copy them into the nginx directory.