diff options
author | Michal Kostewicz <m.kostewicz84@gmail.com> | 2021-02-07 16:26:58 +0100 |
---|---|---|
committer | Michal Kostewicz <m.kostewicz84@gmail.com> | 2021-02-07 16:26:58 +0100 |
commit | bbd2132feede2d8c5e214c4d8a436f5505b9a766 (patch) | |
tree | e92dce863e9a573e2160da570c75178af687ed93 /docker/README.md | |
parent | Revert line which choose DB folder using env. Move Dockerfile to root. Simpli... (diff) | |
download | ferdium-server-bbd2132feede2d8c5e214c4d8a436f5505b9a766.tar.gz ferdium-server-bbd2132feede2d8c5e214c4d8a436f5505b9a766.tar.zst ferdium-server-bbd2132feede2d8c5e214c4d8a436f5505b9a766.zip |
Add script which will use config.txt if exist
Diffstat (limited to 'docker/README.md')
-rw-r--r-- | docker/README.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docker/README.md b/docker/README.md index 995ca8a..2708714 100644 --- a/docker/README.md +++ b/docker/README.md | |||
@@ -76,11 +76,12 @@ The server will be launched at [http://localhost:3333/](http://localhost:3333/) | |||
76 | ## Configuration | 76 | ## Configuration |
77 | 77 | ||
78 | Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 3333:80` would expose port `80` from inside the container to be accessible from the host's IP on port `3333` outside the container. | 78 | Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 3333:80` would expose port `80` from inside the container to be accessible from the host's IP on port `3333` outside the container. |
79 | After the first run, Ferdi-server's configuration is saved inside the `config.txt` file inside your persistent data directory (`/config` in the container). | 79 | After the first run, Ferdi-server's default configuration is saved inside the `config.txt` file inside your persistent data directory (`/config` in the container). |
80 | If any environmental parameter is not passed to the container, its value will be taken from the `config.txt` file. You can also edit the `config.txt` file, but it is advisable to send the environment parameters to the container. | ||
80 | 81 | ||
81 | | Parameter | Function | | 82 | | Parameter | Function | |
82 | | :----: | --- | | 83 | | :----: | --- | |
83 | | `-p <port>:80` | will map the container's port 80 to a port on the host, default is 3333 | | 84 | | `-p <port>:3333` | will map the container's port 80 to a port on the host, default is 3333 | |
84 | | `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development | | 85 | | `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development | |
85 | | `-e EXTERNAL_DOMAIN=<ferdi-serverdomain>` | for specifying external domain address of the ferdi server | | 86 | | `-e EXTERNAL_DOMAIN=<ferdi-serverdomain>` | for specifying external domain address of the ferdi server | |
86 | | `-e DB_CONNECTION=sqlite` | for specifying the database being used, default is sqlite | | 87 | | `-e DB_CONNECTION=sqlite` | for specifying the database being used, default is sqlite | |