|
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. |
2 | 2 |
|
3 | 3 | ## Pre-requisites |
4 | 4 |
|
@@ -26,9 +26,9 @@ cp my-postgres_sample.conf my-postgres.conf |
26 | 26 |
|
27 | 27 | 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. |
28 | 28 |
|
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." |
30 | 30 |
|
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`. |
32 | 32 |
|
33 | 33 |
|
34 | 34 | #### For MacOS |
@@ -78,7 +78,6 @@ You should be able to verify it is running correctly by looking at the logs with |
78 | 78 |
|
79 | 79 | 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. |
80 | 80 |
|
81 | | - |
82 | 81 | ### SSL |
83 | 82 | To enable SSL: |
84 | 83 |
|
@@ -110,22 +109,22 @@ minio_1 | http://172.27.0.5:9000 http://127.0.0.1:9000 |
110 | 109 | ``` |
111 | 110 | 3. Set `AWS_S3_ENDPOINT_URL=http://172.27.0.5:9000`in your `.env` file. |
112 | 111 |
|
113 | | ---- |
| 112 | +### Static files not loading on local setup |
114 | 113 |
|
115 | 114 | If static files are not loaded correctly, adding `DEBUG=True` to the `.env` file can help. |
116 | 115 |
|
117 | 116 |
|
118 | 117 | ### For Apple CPU (M1, M2 chips) |
119 | 118 |
|
120 | | -Add a `docker-compose.override.yml` file with the following content: |
| 119 | +Add a `compose.override.yml` file with the following content: |
121 | 120 |
|
122 | | -```yaml title="docker-compose.override.yml" |
| 121 | +```yaml title="compose.override.yml" |
123 | 122 | services: |
124 | 123 | django: |
125 | 124 | platform: linux/arm64 |
126 | 125 | site_worker: |
127 | 126 | 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"] |
129 | 128 | compute_worker: |
130 | 129 | platform: linux/arm64 |
131 | 130 | ``` |
|
0 commit comments