Running Arcadia

There are two main ways to run Arcadia:

Configuration

The whole project is configured by a single config.yml file at the root of the repository: backend, tracker, periodic tasks and frontend all read it. It is git ignored.

cp config.example.yml config.yml

Then edit config.yml with the values you want. config.example.yml is the reference: it documents every key, and the ones that differ under Docker carry a docker: note giving the value to use.

Other Customization

A few things need to be setup outside of config.yml.

Landing page

Arcadia allows you to display a custom landing page for not logged in users. If frontend.enable_custom_front_page is set to true in config.yml, the file public/home/index.html will be served when visiting root url.

Assets

A few assets need to be setup.

• frontend/src/assets/logo.svg: The logo of the site (displayed on the top left corner of the UI)
• frontend/public/favicon.ico: The favicon for the website
• frontend/public/default_user_avatar.png: The default avatar for users who didn’t set one
• frontend/public/bonus_points_icon.png: The icon for bonus points

additional config files

Some of the services used with Arcadia need their own config files. kiwiirc and ergo are not required to run the rest of Arcadia

cp kiwiirc/config.json.example kiwiirc/config.json
cp ergo/ergo.motd.example ergo/ergo.motd
cp ergo/ergo-conf.yaml.example ergo/ergo-conf.yaml

The API tokens declared in ergo/ergo-conf.yaml must match the ones of the ergo section of config.yml.

Setup Methods

Standard Setup

Install dependencies directly on your system. See Standard Setup for detailed instructions.

Docker Setup

Use containerized deployment with Docker Compose. See Docker Setup for detailed instructions.