From f694067f412903d83438548a346d08e28a68dd15 Mon Sep 17 00:00:00 2001 From: thursday Date: Mon, 12 Jul 2021 20:17:26 -0400 Subject: Update README.md Added links to Docker documentation to explain port mapping, the user runtime variables and container volumes. --- docker/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docker/README.md') 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/) ## Configuration -Container images are configured using parameters passed at runtime (such as those above). +Container 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. **Warning, the use of `config.txt` is now deprecated. Please make sure to pass the correct environmental variables to your container at runtime.** If any environmental parameter is not passed to the container, its value will be taken from the `/config/config.txt` file. | Parameter | Function | | :----: | --- | -| `-p :3333` | Will map the container's port 3333 to a port on the host, default is 3333 | -| `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development **currently this should not be changed** | +| `-p :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 | +| `-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/) | | `-e EXTERNAL_DOMAIN=` | for specifying the external domain address of the Ferdi-server | | `-e DB_CONNECTION=` | 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 | `-e IS_REGISTRATION_ENABLED=true` | for specifying whether to allow user registration, default is true | | `-e CONNECT_WITH_FRANZ=true` | for specifying whether to enable connections to the Franz server, default is true | | `-e DATA_DIR=data` | for specifying the SQLite database folder, default is database | -| `-v :/config` | this will store persistent ENV data on the docker host | +| `-v :/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 | | `-v :/app/data` | this will store Ferdi-server's database on the docker host for persistence | | `-v :/app/recipes` | this will store Ferdi-server's recipes on the docker host for persistence | -- cgit v1.2.3-54-g00ecf