Deployment with Docker

Before you begin

Make sure you completed all steps in the first steps page.

Requirements

Set up environment variables

In RABIT-BACKEND, copy .env.example file to .env

cp .env.example

Then fill out the database environment variables as follows:

DATA_PATH=./data
DB_HOST=db
DB_USER=root
DB_PASSWORD=replace-this
DB_NAME=rabit

See the Firebase page for more information on setting up Firebase.

Any variables not listed above should not be changed, unless you understand the ramifications and how to deal with any issue that may arise.

Installation

In the RABIT-COMMON directory, run:

docker-compose up --build

The app will be running at http://localhost:8080/

In case of npm error, you may need to return to RABIT-FRONTEND and/or RABIT-BACKEND and run:

rm package-lock.json
rm -rf node_modules
npm install

Afterwards, return to RABIT-COMMON and re-run docker-compose up --build

Update

When you are making changes to the code, stop the containers and run

docker-compose up --build --force-recreate

Doing this will force rebuild and recreate the docker containers.

Uninstall

Remove the container without deleting database data:

docker-compose down

Remove the container and delete all data:

⚠️ WARNING

This will delete all plots, accounts and everything else stored in the database. This operation is irreversible.

This does NOT delete any user data in Firebase. Ensure that you deal with this appropriately to avoid any data synchronisation issue in the future.

docker-compose down -v

RABIT Documentation