diff options
author | Michal Kostewicz <m.kostewicz84@gmail.com> | 2021-02-09 21:28:23 +0100 |
---|---|---|
committer | Michal Kostewicz <m.kostewicz84@gmail.com> | 2021-02-09 21:28:23 +0100 |
commit | 0a3ce5a9e37dd917cfabdf97fdc18a41d88c65eb (patch) | |
tree | 01e9767525f8c710b64119d8fd1e0c1c0807e49b /docker/README.md | |
parent | Fix DATA_DIR examples in README.md (diff) | |
download | ferdium-server-0a3ce5a9e37dd917cfabdf97fdc18a41d88c65eb.tar.gz ferdium-server-0a3ce5a9e37dd917cfabdf97fdc18a41d88c65eb.tar.zst ferdium-server-0a3ce5a9e37dd917cfabdf97fdc18a41d88c65eb.zip |
Fix all issues found on CR -> especially update README.md, remove creation of new config.txt, update ignore files.
Diffstat (limited to 'docker/README.md')
-rw-r--r-- | docker/README.md | 16 |
1 files changed, 5 insertions, 11 deletions
diff --git a/docker/README.md b/docker/README.md index 8518e15..1cea8ae 100644 --- a/docker/README.md +++ b/docker/README.md | |||
@@ -76,9 +76,11 @@ The server will be launched at [http://localhost:3333/](http://localhost:3333/) | |||
76 | 76 | ||
77 | ## Configuration | 77 | ## Configuration |
78 | 78 | ||
79 | 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 | Container images are configured using parameters passed at runtime (such as those above). |
80 | 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 | |
81 | 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. | 81 | **Warning ,using `config.txt` will be deprecated in the future releases.** |
82 | |||
83 | If any of environmental parameters is not passed to the container, its value will be taken from the `/config/config.txt` file. **The previous functionality of saving container parameters in this file is now removed.** | ||
82 | 84 | ||
83 | | Parameter | Function | | 85 | | Parameter | Function | |
84 | | :----: | --- | | 86 | | :----: | --- | |
@@ -213,13 +215,5 @@ docker build \ | |||
213 | -t getferdi/ferdi-server:latest . | 215 | -t getferdi/ferdi-server:latest . |
214 | ``` | 216 | ``` |
215 | 217 | ||
216 | ## Versions | ||
217 | |||
218 | * **05.02.21:** - Repository moved to ferdi-server repository | ||
219 | * **19.01.21:** - Updated Mail SSL and DB SLL settings | ||
220 | * **20.09.20:** - Updated SMTP Mailer settings for password reset. | ||
221 | * **21.06.20:** - Rebase to Alpine 3.11 and added Mailer settings. | ||
222 | * **25.09.19:** - Initial Release. | ||
223 | |||
224 | ## License | 218 | ## License |
225 | Ferdi-server-docker and ferdi-server are licensed under the MIT License. | 219 | Ferdi-server-docker and ferdi-server are licensed under the MIT License. |