Running Arcadia

There are two main ways to run Arcadia:

Environment Configuration

# Copy example environment files and edit them with the values you want
cp backend/api/.env.example backend/api/.env
cp backend/storage/.env.example backend/storage/.env
cp backend/periodic-tasks/.env.example backend/periodic-tasks/.env
cp frontend/.env.example frontend/.env
cp shared/.env.example shared/.env
cp tracker/arcadia_tracker/.env.example tracker/arcadia_tracker/.env

Other Customization

A few things need to be setup outside of the env variables.

Arcadia allows you to display a custom landing page for not logged in users. If VITE_ENABLE_CUSTOM_FRONT_PAGE is set to true in the frontend .env file, 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

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.

Arcadia Documentation