aboutsummaryrefslogtreecommitdiffstats
path: root/docker/README.md
diff options
context:
space:
mode:
authorLibravatar thursday <xthursdayx@mailbox.org>2021-07-12 22:25:19 -0400
committerLibravatar GitHub <noreply@github.com>2021-07-12 22:25:19 -0400
commite359a655f0a0d1e2b62fd98a1aba8ede8dac9399 (patch)
tree71470eee674ae71280f72bbc4087d8d934d5655c /docker/README.md
parentUpdate docker-compose.yml (diff)
downloadferdium-server-e359a655f0a0d1e2b62fd98a1aba8ede8dac9399.tar.gz
ferdium-server-e359a655f0a0d1e2b62fd98a1aba8ede8dac9399.tar.zst
ferdium-server-e359a655f0a0d1e2b62fd98a1aba8ede8dac9399.zip
Update README.md
Updated migration text and deprecation warning.
Diffstat (limited to 'docker/README.md')
-rw-r--r--docker/README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docker/README.md b/docker/README.md
index 144a766..dc49e68 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -69,7 +69,7 @@ To create the docker container with the proper parameters:
69 docker-compose up 69 docker-compose up
70The server will be launched at [http://localhost:3333/](http://localhost:3333/) address. 70The server will be launched at [http://localhost:3333/](http://localhost:3333/) address.
71 71
72**Existing users please note:** The latest updates to Ferdi-server and the Ferdi-server Docker image introduce changes to the default SQLite database name and location, please see the comments in the sample [./docker/docker-compose.yml](https://github.com/getferdi/server/tree/master/docker/docker-compose.yml) in order to continue using your existing database. 72**Existing users please note:** The latest updates to Ferdi-server and the Ferdi-server Docker image introduce changes to the default SQLite database name and location, as well as the internal containeer port. Please see the comments in the sample [./docker/docker-compose.yml](https://github.com/getferdi/server/tree/master/docker/docker-compose.yml) in order to continue using your existing database.
73 73
74## Configuration 74## Configuration
75 75
@@ -80,7 +80,7 @@ Container images are configured using parameters passed at runtime (such as thos
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. See the [Docker docs](https://docs.docker.com/config/containers/container-networking/) for more information on port mapping | 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 about port mapping |
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/) | 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 |