aboutsummaryrefslogtreecommitdiffstats
path: root/docker
diff options
context:
space:
mode:
authorLibravatar thursday <xthursdayx@mailbox.org>2021-07-12 20:17:26 -0400
committerLibravatar GitHub <noreply@github.com>2021-07-12 20:17:26 -0400
commitf694067f412903d83438548a346d08e28a68dd15 (patch)
tree5e93b48f4ffdd4d6b0dcc32b7ab299cbf63da94e /docker
parentUpdate README.md (diff)
downloadferdium-server-f694067f412903d83438548a346d08e28a68dd15.tar.gz
ferdium-server-f694067f412903d83438548a346d08e28a68dd15.tar.zst
ferdium-server-f694067f412903d83438548a346d08e28a68dd15.zip
Update README.md
Added links to Docker documentation to explain port mapping, the user runtime variables and container volumes.
Diffstat (limited to 'docker')
-rw-r--r--docker/README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docker/README.md b/docker/README.md
index bb996ae..d32f488 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -73,15 +73,15 @@ The server will be launched at [http://localhost:3333/](http://localhost:3333/)
73 73
74## Configuration 74## Configuration
75 75
76Container images are configured using parameters passed at runtime (such as those above). 76Container images are configured using parameters passed at runtime (such as those above). An explanaition of the default parameters is included below, but please see [the Docker documentation](https://docs.docker.com/get-started/overview/) for additional information.
77 77
78**Warning, the use of `config.txt` is now deprecated. Please make sure to pass the correct environmental variables to your container at runtime.** 78**Warning, the use of `config.txt` is now deprecated. Please make sure to pass the correct environmental variables to your container at runtime.**
79<strike>If any environmental parameter is not passed to the container, its value will be taken from the `/config/config.txt` file.</strike> 79<strike>If any environmental parameter is not passed to the container, its value will be taken from the `/config/config.txt` file.</strike>
80 80
81| Parameter | Function | 81| Parameter | Function |
82| :----: | --- | 82| :----: | --- |
83| `-p <port>:3333` | Will map the container's port 3333 to a port on the host, default is 3333 | 83| `-p <port>:3333` | Will map the container's port 3333 to a port on the host, default is 3333. See the [Docker docs](https://docs.docker.com/config/containers/container-networking/) for more information on port mapping |
84| `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development **currently this should not be changed** | 84| `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development **currently this should not be changed**. See the [Docker docs](https://docs.docker.com/) for more information on the use of environmental variables in [Command-line](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only) and [Docker Compose](https://docs.docker.com/compose/environment-variables/) |
85| `-e EXTERNAL_DOMAIN=<ferdi-serverdomain>` | for specifying the external domain address of the Ferdi-server | 85| `-e EXTERNAL_DOMAIN=<ferdi-serverdomain>` | for specifying the external domain address of the Ferdi-server |
86| `-e DB_CONNECTION=<databasedriver` | for specifying the database being used, default is sqlite, see [below](#supported-databases-and-drivers) for other options | 86| `-e DB_CONNECTION=<databasedriver` | for specifying the database being used, default is sqlite, see [below](#supported-databases-and-drivers) for other options |
87| `-e DB_HOST=<yourdbhost>` | for specifying the database host, default is 127.0.0.1 | 87| `-e DB_HOST=<yourdbhost>` | for specifying the database host, default is 127.0.0.1 |
@@ -102,7 +102,7 @@ Container images are configured using parameters passed at runtime (such as thos
102| `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is true | 102| `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is true |
103| `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is true | 103| `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is true |
104| `-e DATA_DIR=data` | for specifying the SQLite database folder, default is database | 104| `-e DATA_DIR=data` | for specifying the SQLite database folder, default is database |
105| `-v <path to data>:/config` | this will store persistent ENV data on the docker host | 105| `-v <path to data>:/config` | this will store persistent configuration data on the docker host. See the [Docker docs](https://docs.docker.com/storage/volumes/) for more information on the use of container volumes |
106| `-v <path to database>:/app/data` | this will store Ferdi-server's database on the docker host for persistence | 106| `-v <path to database>:/app/data` | this will store Ferdi-server's database on the docker host for persistence |
107| `-v <path to recipes>:/app/recipes` | this will store Ferdi-server's recipes on the docker host for persistence | 107| `-v <path to recipes>:/app/recipes` | this will store Ferdi-server's recipes on the docker host for persistence |
108 108