aboutsummaryrefslogtreecommitdiffstats
path: root/docker
diff options
context:
space:
mode:
authorLibravatar thursday <xthursdayx@mailbox.org>2021-07-18 02:38:58 -0400
committerLibravatar GitHub <noreply@github.com>2021-07-18 02:38:58 -0400
commit2f0dc9ccb9b3957fdddfaae1470613643df54d31 (patch)
tree1dbcd69b1d7f589c943650bfd49e2f96da483a0f /docker
parentUpdate README.md (diff)
downloadferdium-server-2f0dc9ccb9b3957fdddfaae1470613643df54d31.tar.gz
ferdium-server-2f0dc9ccb9b3957fdddfaae1470613643df54d31.tar.zst
ferdium-server-2f0dc9ccb9b3957fdddfaae1470613643df54d31.zip
Update README.md
Diffstat (limited to 'docker')
-rw-r--r--docker/README.md10
1 files changed, 4 insertions, 6 deletions
diff --git a/docker/README.md b/docker/README.md
index d427d3e..fa7ff78 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -64,11 +64,9 @@ To create the docker container with the proper parameters:
64### docker-compose 64### docker-compose
65 65
66 You can use the provided sample [docker-compose.yml](https://github.com/getferdi/server/tree/master/docker/docker-compose.yml) if you are happy with the default environmental variables. This will pull the latest image from Docker Hub or use a local copy of the image which you can build using the instructions provided in the [Building locally section](#building-locally). 66 You can use the provided sample [docker-compose.yml](https://github.com/getferdi/server/tree/master/docker/docker-compose.yml) if you are happy with the default environmental variables. This will pull the latest image from Docker Hub or use a local copy of the image which you can build using the instructions provided in the [Building locally section](#building-locally).
67 67
68 To start the application, use 68 To start the application, use `docker-compose up -d`.
69 69The server will be launched at [http://localhost:3333/](http://localhost:3333/) address.
70 docker-compose up -d
71The server will be launched at [http://localhost:3333/](http://localhost:3333/) address.
72 70
73## Configuration 71## Configuration
74 72
@@ -135,7 +133,7 @@ To use a different email sender than the default, SMTP, enter the correct inform
135| :----: | --- | 133| :----: | --- |
136| `-p 3333:3333` | existing Ferdi-server users will need to update their port mappings from `80:3333` to `3333:3333` | 134| `-p 3333:3333` | existing Ferdi-server users will need to update their port mappings from `80:3333` to `3333:3333` |
137| `-e DB_PASSWORD=development` | existing Ferdi-server users who use the built-in sqlite database should use the database name `development` | 135| `-e DB_PASSWORD=development` | existing Ferdi-server users who use the built-in sqlite database should use the database name `development` |
138| `-e DATA_DIR=/app/database` | existing Ferdi-server users should ensure that they add this variable to ensure data persistence | 136| `-e DATA_DIR=/app/database` | existing Ferdi-server users should add this environmental variable to ensure data persistence |
139| `-v <path to data on host>=/app/databases` | existing Ferdi-server users who use the built-in sqlite database should use the volume name `/app/database` | 137| `-v <path to data on host>=/app/databases` | existing Ferdi-server users who use the built-in sqlite database should use the volume name `/app/database` |
140 138
141## NGINX config block 139## NGINX config block