aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar thursday <xthursdayx@mailbox.org>2021-07-12 22:41:45 -0400
committerLibravatar GitHub <noreply@github.com>2021-07-12 22:41:45 -0400
commit9c21478009e5dbda8084c3fb6da9603ca157de9a (patch)
treea70fb8cc829f0db18467f3ffeb1cfc4204655eaf /README.md
parentUpdate docker-compose.yml (diff)
downloadferdium-server-9c21478009e5dbda8084c3fb6da9603ca157de9a.tar.gz
ferdium-server-9c21478009e5dbda8084c3fb6da9603ca157de9a.tar.zst
ferdium-server-9c21478009e5dbda8084c3fb6da9603ca157de9a.zip
Update README.md
Further clarified migration pathway for existing users.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7865704..5d93847 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,7 @@ The easiest way to set up Ferdi server on your server is with Docker.
41The Docker image can be run as is, with the default SQLite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). 41The Docker image can be run as is, with the default SQLite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc).
42After setting up the docker container we recommend you set up an NGINX reverse proxy to access Ferdi-server outside of your home network and protect it with an SSL certificate. 42After setting up the docker container we recommend you set up an NGINX reverse proxy to access Ferdi-server outside of your home network and protect it with an SSL certificate.
43 43
44**Warning**, please note that the use of the previous `config.txt` is now deprecated. Make sure to pass the correct environmental variables to your container at runtime. If you are an existing Ferdi-server user please see [the Ferdi docker documentation](./docker/README.md) for more information. 44**Warning**, please note that the use of the previous `config.txt` is now deprecated and a number of environmental variables have changed, specifically the default database name and local, the internal contianer port, and an additional `DATA_DIR` variable has been added. Make sure to pass the correct environmental variables to your container at runtime. If you are an existing Ferdi-server user please see [the Ferdi docker documentation](./docker/README.md) and the example [docker-compose.yml](./docker/docker-compose.yml) for more information.
45 45
461. Pull the Docker image 461. Pull the Docker image
47 47
@@ -73,7 +73,7 @@ After setting up the docker container we recommend you set up an NGINX reverse p
73 -e IS_DASHBOARD_ENABLED=true \ 73 -e IS_DASHBOARD_ENABLED=true \
74 -e IS_REGISTRATION_ENABLED=true \ 74 -e IS_REGISTRATION_ENABLED=true \
75 -e CONNECT_WITH_FRANZ=true \ 75 -e CONNECT_WITH_FRANZ=true \
76 -p <port>:80 \ 76 -p <port>:3333 \
77 -v <path to data>:/config \ 77 -v <path to data>:/config \
78 -v <path to database>:/app/database \ 78 -v <path to database>:/app/database \
79 -v <path to recipes>:/app/recipes \ 79 -v <path to recipes>:/app/recipes \