aboutsummaryrefslogtreecommitdiffstats
path: root/docker/README.md
diff options
context:
space:
mode:
authorLibravatar thursday <xthursdayx@mailbox.org>2021-07-18 01:45:27 -0400
committerLibravatar GitHub <noreply@github.com>2021-07-18 01:45:27 -0400
commit43b328237fccb997489b31f250790b072a2a6c18 (patch)
tree4a011818a46be1427c575df42783a0b9e200ed9f /docker/README.md
parentUpdate README.md (diff)
downloadferdium-server-43b328237fccb997489b31f250790b072a2a6c18.tar.gz
ferdium-server-43b328237fccb997489b31f250790b072a2a6c18.tar.zst
ferdium-server-43b328237fccb997489b31f250790b072a2a6c18.zip
Update README.md
Diffstat (limited to 'docker/README.md')
-rw-r--r--docker/README.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/docker/README.md b/docker/README.md
index 840ca34..1b0e4aa 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -20,7 +20,9 @@ A custom Ferdi-server allows you to experience the full potential of the Ferdi C
20 20
21Here are some example snippets to help you get started creating a container. 21Here are some example snippets to help you get started creating a container.
22 22
23The docker can be run as is, with the default sqlite database, or you can modify your environment variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). After setting up the docker container you will likely need to create a reverse proxy to access Ferdi-server outside of your home network, using a webserver such as NGINX. 23The docker can be run as is, with the default sqlite database, or you can modify your environment variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). After setting up the docker container you will need to create a reverse proxy to access Ferdi-server outside of your home network, using a webserver such as NGINX.
24
25**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 [Migration section](#migrating-from-an-existing-ferdi-server) below in order to continue using your existing Ferdi-server database.
24 26
25### docker 27### docker
26 28
@@ -68,14 +70,12 @@ To create the docker container with the proper parameters:
68 docker-compose up -d 70 docker-compose up -d
69The server will be launched at [http://localhost:3333/](http://localhost:3333/) address. 71The server will be launched at [http://localhost:3333/](http://localhost:3333/) address.
70 72
71**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.
72
73## Configuration 73## Configuration
74 74
75Container 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. 75Container 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.
76 76
77**Warning, the use of `config.txt` is now deprecated. Please make sure to pass the correct environmental variables to your container at runtime.**
78<strike>If any environmental parameter is not passed to the container, its value will be taken from the `/config/config.txt` file.</strike> 77<strike>If any environmental parameter is not passed to the container, its value will be taken from the `/config/config.txt` file.</strike>
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 79
80| Parameter | Function | 80| Parameter | Function |
81| :----: | --- | 81| :----: | --- |
@@ -128,6 +128,15 @@ To use a different email sender than the default, SMTP, enter the correct inform
128| SparkPost | SPARKPOST_API_KEY | 128| SparkPost | SPARKPOST_API_KEY |
129| Mailgun | MAILGUN_DOMAIN, MAILGUN_API_REGION, MAILGUN_API_KEY | 129| Mailgun | MAILGUN_DOMAIN, MAILGUN_API_REGION, MAILGUN_API_KEY |
130| (**Deprecated**) Ethereal | A disposable account is created automatically if you choose this option. | 130| (**Deprecated**) Ethereal | A disposable account is created automatically if you choose this option. |
131
132## Migrating from an existing Ferdi-server
133
134| Parameter | Function |
135| :----: | --- |
136| `-p 3333:3333` | existing Ferdi-server users will need to update their port mappings from `80:3333` to `3333:3333` |
137| `-e DB_PASSWORD=development` | existing Ferdi-server users who use the built-in sqlite database should use the database name `development` |
138| `-e DATA_DIR=/app/database` | existing Ferdi-server users should ensure that they add this variable to ensure data persistence |
139| `-v <path to data>=/app/databases` | existing Ferdi-server users who use the built-in sqlite database should use the volume name `/app/database` |
131 140
132## NGINX config block 141## NGINX config block
133To access Ferdi-server from outside of your home network on a subdomain use this server block: 142To access Ferdi-server from outside of your home network on a subdomain use this server block: