Skip to content

Codabench-Installation.md

Latest commit

 

History

History
153 lines (97 loc) · 5.25 KB

Codabench-Installation.md

File metadata and controls

153 lines (97 loc) · 5.25 KB

This guide explains how to quickly and easily install Codabench, typically for local development and test. Details about online deployment are given in How to deploy Codabench on your server page.

Pre-requisites

Install Docker and Docker Compose

Clone Repository

Download the Codabench repository:

git clone https://github.com/codalab/codabench

Edit the settings (.env)

The .env file contains the settings of your instance. On a fresh installation, you will need to use the following command to get your .env file:

cd codabench
cp .env_sample .env
cp my-postgres_sample.conf my-postgres.conf

Then edit the necessary settings inside. The most important are the database, storage, and Caddy/SSL settings in the .env. For a quick local setup, you should not need to edit these files. For a public server deployment, you will have to modify some settings.

!!! warning "It is important to change the default passwords if you intend for the instance to be public."

If you are using AWS_S3_ENDPOINT_URL=http://minio:9000/ in your .env, edit your /etc/hosts file by adding this line 127.0.0.1 minio.

For MacOS

In .env, replace:

AWS_S3_ENDPOINT_URL=http://minio:9000/

by

AWS_S3_ENDPOINT_URL=http://docker.for.mac.localhost:9000/
WORKER_BUNDLE_URL_REWRITE=http://docker.for.mac.localhost:9000|http://minio:9000

!!! note "If needed, some troubleshooting of this step is provided at the end of this page or in this page"

Start the service

To deploy the platform, run:

docker compose up -d

Run the following commands

Create the required tables in the database:

docker compose exec django ./manage.py migrate

Generate the required static resource files:

docker compose exec django ./manage.py collectstatic --noinput

You should be able to verify it is running correctly by looking at the logs with docker compose logs -f and by visiting localhost:80 (Depending on your configuration).

Advanced Configuration

Testing

To run automated tests for your local instance, get inside the Django container with docker compose exec django bash then run py.test to start the automated tests.

SSL

To enable SSL:

  • If you already have a DNS for your server that is appropriate, in the .env simply set DOMAIN_NAME to your DNS. Remove any port designation like :80. This will have Caddy serve both HTTP and HTTPS.

!!! warning "For a public instance, HTTPS is strongly recomended"

Validate user account on local instance

When deploying a local instance, the email server is not configured by default, so you won't receive the confirmation email during signup.

To manually confirm your account:

  1. Find the confirmation link in the Django logs using docker compose logs -f django
  2. Replace example.com by localhoston the URL and open it in your browser.

Another way is to go inside the Django containers and use commands like in administrative procedures.

Troubleshooting storage endpoint URL

You may have to manually change the endpoint URL to have your local instance working. This may be an OS related issue. Here is a possible fix:

  1. docker compose logs -f minio
  2. Grab the first one of these IP addresses:
minio_1           | Browser Access:
minio_1           |    http://172.27.0.5:9000  http://127.0.0.1:9000
  1. Set AWS_S3_ENDPOINT_URL=http://172.27.0.5:9000in your .env file.

Static files not loading on local setup

If static files are not loaded correctly, adding DEBUG=True to the .env file can help.

For Apple CPU (M1, M2 chips)

Add a compose.override.yml file with the following content:

services:
  django:
    platform: linux/arm64
  site_worker:
    platform: linux/arm64
    command: ["celery -A celery_config worker -B -Q site-worker -l info -n site-worker@%n --concurrency=2"]
  compute_worker:
    platform: linux/arm64

Storage

By default, Codabench uses a built-in MinIO container. Some users may want a different solution, such as S3 or Azure. The configuration will vary slightly for each different type of storage.

For all possible supported storage solutions, see: https://django-storages.readthedocs.io/en/latest/

Remote Compute Workers

To set up remote compute workers, you can follow the steps described in our Compute Worker Management page.

Troubleshooting

Read the following guide for troubleshooting: How to deploy Codabench.

Also, adding DEBUG=True to the .env file can help with troubleshooting the deployment.

Open a Github issue to find help with your installation

Online Deployement

For information about online deployment of Codabench, go to the following page