HOFFNUNG 3000
Handbook

Installation

There are different ways on how to install HOFFNUNG 3000. We tried to keep the technical steps required as small as possible, with some patience you will be able to run HOFFNUNG 3000, even if you have never dealt with these things before.

Simple setup via Heroku

  1. Register a new account on Heroku if you don’t already have one

  2. Click the following link to automatically deploy HOFFNUNG 3000 and a database on your Heroku server:

    https://heroku.com/deploy?template=https://github.com/adzialocha/hoffnung3000

  3. Choose a name and region, then click Deploy app. Wait until the installation finished on your server

  4. Now the platform is ready and can be visited: https://<your-app-name>.herokuapp.com. Read the Usage guide to learn how to use HOFFNUNG 3000

Please note that this simple setup is not recommended for official festival settings. Read further to learn how to prepare HOFFNUNG 3000 for production.

Install manually

For this setup we assume you already have a running NodeJS server environment, SMTP mail server and a PostgreSQL database installed.

You can find the source code of HOFFNUNG 3000 in a git repository hosted on: github.com/adzialocha/hoffnung3000.

Requirements

1. Configuration

Crucial settings of HOFFNUNG 3000 are configured via environment variables, further configuration can be handled via the Admin panel after setup.

Make sure you’ve set NPM_CONFIG_PRODUCTION to false when installing HOFFNUNG 3000 via Heroku, otherwise the build process will fail. Read more about it here.

Required variables

Optional: AWS S3

By default HOFFNUNG 3000 stores all user uploads (images) in a folder named uploads on your server which is not recommended. Use AWS S3 Cloud Storage to externally host images and separate user content from the application server.

  1. Create an AWS S3 Bucket and assign the right permissions (public readable, writeable by authenticated AWS user)

  2. Define the needed AWS environment variables: AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_BUCKET_NAME

Please note: It is not possible to change to S3 after using the local storage setup without loosing user data.

Optional: PayPal

This is an optional step and only required if you want to sell tickets to visitors and/or participants via PayPal.

  1. Create a PayPal Developer Account and get an access token for testing and live setup

  2. Store the access token and id as environment variables PAYPAL_ID and PAYPAL_SECRET

  3. Define the PAYPAL_RETURN_URL (https://your-domain.com/api/auth/signup/paypal/success) and PAYPAL_CANCEL_URL (https://your-domain.com/api/auth/signup/paypal/cancel)

Optional: gif-stream-server

The gif-stream-server is an independent server written in Go, requiring AWS S3. It has to run independently of HOFFNUNG 3000. You can read more about the setup here.

After setup, you can add the gif-stream-server URL (without trailing slash!) in the HOFFNUNG 3000 admin panel configuration to connect the platform to the gif-stream-server.

2. Install dependencies

Install all JavaScript dependencies via npm, this command will also automatically build all assets (npm run build) for production use:

npm install

3. Database migration and setup

To create all required tables in the given database, you issue the following commands:

npm run db:migrate
npm run db:seed

The seed will create a default admin user with email: admin@domain.com and passwort: adminadmin. Please change the credentials after first login in the admin panel.

4. Start server

Run the following command to run the server (make sure the build and migration process was successful before):

npm start