Deployment

Using gradle

In order to use this project with gradle, follow these steps:

1. git clone https://github.com/BreakOutEvent/breakout-backend.git
2. ./gradlew bootRun
3. Enjoy! 🎉

Using docker

Note: This solution includes building the image from the Dockerfile yourself. In further versions, a prebuilt version will be pushed to docker-hub or something similar.

1. git clone https://github.com/BreakOutEvent/breakout-backend.git
2. docker build -t breakout/backend
3. docker run -p 8082:8082 breakout/backend

Configuration

The following environment variables should be set. Testing fallbacks for most of the values are fetched from application.properties, but these should not be used in production!

Connection to Mailer

Env Variable	Description
BREAKOUT_MAILER_URL	The URL of the breakout-mailer, which is responsible for sending emails to users
BREAKOUT_MAILER_PORT	The port the mailer is listening on
BREAKOUT_MAILER_XAUTHTOKEN	A token needed to authenticate at the mailer (this is a shared secret between Mailer and Backend and needs to be set at the mailer accordingly!)

Admin settings

Env Variable	Description
BREAKOUT_ADMIN_EMAIL	The email address used for logging in to the admin account (This account is activated by default)
BREAKOUT_ADMIN_PASSWORD	The password used for logging in to the admin account

Connection to media upload

Env Variable	Description
BREAKOUT_API_JWT_SECRET	A shared secret needed to generate jwt-tokens for api communications for backend-services. (needs to be set at the media uploader/recoder accordingly)

Information about the host

This information is needed to create valid activation links

Env Variable	Description
BREAKOUT_API_HOST	The hostname at which the api can be reached (e.g. break-out.org)
BREAKOUT_API_PORT	The port of the API (e.g. 80)