aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar thursday <xthursdayx@mailbox.org>2021-07-18 00:57:18 -0400
committerLibravatar GitHub <noreply@github.com>2021-07-18 00:57:18 -0400
commit95d60b83a7946e37b78641e76d40a90eeb6a804a (patch)
tree50679ce50e0f8e718fd7934db1f51afae759b7ff /README.md
parentUpdate docker/docker-compose.yml (diff)
downloadferdium-server-95d60b83a7946e37b78641e76d40a90eeb6a804a.tar.gz
ferdium-server-95d60b83a7946e37b78641e76d40a90eeb6a804a.tar.zst
ferdium-server-95d60b83a7946e37b78641e76d40a90eeb6a804a.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index ec5563a..a04f741 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@ If you are not interested in doing this you can use our official instance of Fer
30- [x] Workspace support 30- [x] Workspace support
31- [x] Functioning service store 31- [x] Functioning service store
32- [x] User dashboard 32- [x] User dashboard
33- [x] Export/import data to other Ferdi servers 33- [x] Export/import data to other Ferdi-servers
34- [ ] Password recovery 34- [ ] Password recovery
35- [ ] Recipe update 35- [ ] Recipe update
36 36
@@ -39,7 +39,7 @@ If you are not interested in doing this you can use our official instance of Fer
39The easiest way to set up Ferdi-server on your server is with Docker. 39The easiest way to set up Ferdi-server on your server is with Docker.
40 40
41The Docker image can be run as is, with the default SQLite database or you can modify 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 modify 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 and a number of environmental variables have changed, specifically the default database name and location, the internal container 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 about migrating to the new image. 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 location, the internal container 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 about migrating to the new image.
45 45
@@ -85,7 +85,7 @@ After setting up the docker container we recommend you set up an NGINX reverse p
85 85
863. Optionally, you can [set up Nginx as a reverse proxy](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04#set-up-nginx-as-a-reverse-proxy-server). 863. Optionally, you can [set up Nginx as a reverse proxy](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04#set-up-nginx-as-a-reverse-proxy-server).
87 87
88For more information on configuring the Docker image, please read [the ferdi docker documentation](./docker/README.md). 88For more information on configuring the Docker image, please read [the Ferdi docker documentation](./docker/README.md).
89 89
90### Manual setup 90### Manual setup
91 91
@@ -120,7 +120,7 @@ franz-server's configuration is saved inside an `.env` file. Besides AdonisJS's
120 120
121Ferdi-server allows you to import your full Franz account, including all its settings. 121Ferdi-server allows you to import your full Franz account, including all its settings.
122 122
123To import your Franz account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz account details. ferdi-server will create a new user with the same credentials and copy your Franz settings, services and workspaces. 123To import your Franz account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz account details. Ferdi-server will create a new user with the same credentials and copy your Franz settings, services and workspaces.
124 124
125## Transferring user data 125## Transferring user data
126 126