Skip to content

Commit

Permalink
Update docker README
Browse files Browse the repository at this point in the history
  • Loading branch information
hsmett authored and genglert committed Aug 28, 2024
1 parent 9761c36 commit bbff0fe
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ It is developed in [Python](https://www.python.org/) with the web framework [Dja

This [Docker](https://www.docker.com/) image contains everything you need to run a local demo instance of Creme CRM, for testing purposes.

We do not provide a `latest` docker image tag. The full list of tags is available [here](https://hub.docker.com/repository/docker/cremecrm/cremecrm-demo/tags).

Please note that this is **not a production ready image**, as it would require a finer configuration.


Expand All @@ -21,7 +23,7 @@ Please note that this is **not a production ready image**, as it would require a
Starting an instance is simple:

```commandline
docker run --detach --rm --name creme_demo --publish 8001:80 --volume creme_data:/srv/creme/data cremecrm/cremecrm-demo:latest
docker run --detach --rm --name creme_demo --publish 8001:80 --volume creme_data:/srv/creme/data cremecrm/cremecrm-demo:2.5.11
```

This command will run a docker container in daemon mode, named `creme_demo`:
Expand All @@ -34,7 +36,7 @@ The exhaustive list of available configuration options can be found in the Envir
Here is an example command setting up an instance using the French locale:

```commandline
docker run --detach --rm --name creme_demo --publish 8001:80 --volume creme_data:/srv/creme/data --env CREME_LANGUAGE_CODE=fr --env CREME_TIME_ZONE=Europe/Paris cremecrm/cremecrm-demo:latest
docker run --detach --rm --name creme_demo --publish 8001:80 --volume creme_data:/srv/creme/data --env CREME_LANGUAGE_CODE=fr --env CREME_TIME_ZONE=Europe/Paris cremecrm/cremecrm-demo:2.6.0
```

The installation process can take a minute or two the first time the command runs.
Expand Down Expand Up @@ -69,8 +71,9 @@ Default value: `'django.db.backends.sqlite3'`.


#### `CREME_DATABASE_NAME`
Name of the database, or path to the database file if using 'sqlite3'.
Name of the database, or path to the database file if using 'sqlite3'.
Default value: `'/srv/creme/data/cremecrm.db'`.

It has been placed in the volume defined in the run command, for persistence.


Expand Down Expand Up @@ -109,6 +112,7 @@ Default value: `'en'`.
#### `CREME_MEDIA_ROOT`
Path to the root directory where user media will be stored.
Default value: `'/srv/creme/data/media/upload'`.

It has been placed in the volume defined in the run command, for persistence.


Expand Down

0 comments on commit bbff0fe

Please sign in to comment.