Skip to content

Commit 3e9155a

Browse files
authored
Update Codabench-Installation.md
1 parent d86ef18 commit 3e9155a

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

documentation/docs/Developers_and_Administrators/Codabench-Installation.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Compared to Codalab, installing Codabench should be relatively easy since you no longer have to worry about special ways to set up SSL or storage. We include default solutions that should handle that for most basic uses.
1+
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](How-to-deploy-Codabench-on-your-server.md) page.
22

33
## Pre-requisites
44

@@ -26,9 +26,9 @@ cp my-postgres_sample.conf my-postgres.conf
2626

2727
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](How-to-deploy-Codabench-on-your-server.md), you will have to modify some settings.
2828

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

31-
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`
31+
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`.
3232

3333

3434
#### For MacOS
@@ -78,7 +78,6 @@ You should be able to verify it is running correctly by looking at the logs with
7878

7979
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.
8080

81-
8281
### SSL
8382
To enable SSL:
8483

@@ -110,22 +109,22 @@ minio_1 | http://172.27.0.5:9000 http://127.0.0.1:9000
110109
```
111110
3. Set `AWS_S3_ENDPOINT_URL=http://172.27.0.5:9000`in your `.env` file.
112111

113-
---
112+
### Static files not loading on local setup
114113

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

117116

118117
### For Apple CPU (M1, M2 chips)
119118

120-
Add a `docker-compose.override.yml` file with the following content:
119+
Add a `compose.override.yml` file with the following content:
121120

122-
```yaml title="docker-compose.override.yml"
121+
```yaml title="compose.override.yml"
123122
services:
124123
django:
125124
platform: linux/arm64
126125
site_worker:
127126
platform: linux/arm64
128-
command: celery -A celery_config worker -B -Q site-worker -l info -n site-worker@%n --concurrency=2
127+
command: ["celery -A celery_config worker -B -Q site-worker -l info -n site-worker@%n --concurrency=2"]
129128
compute_worker:
130129
platform: linux/arm64
131130
```

0 commit comments

Comments
 (0)