From b185c426ddf1fdecfffac436bd411e3c45b61916 Mon Sep 17 00:00:00 2001
From: thursday
Date: Mon, 12 Jul 2021 19:52:48 -0400
Subject: Update README.md
Added a warning about the deprecation of config.txt in the docker image, made Ferdi-server capitalization consistent, and fixed grammar throughout.
---
README.md | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 38ab5bc..f3e8845 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,10 @@
-# ferdi-server
+# Ferdi-server
Official Server software for the [Ferdi Messaging Browser](https://getferdi.com)
-- [ferdi-server](#ferdi-server)
+- [Ferdi-server](#ferdi-server)
- [Why use a custom Ferdi server?](#why-use-a-custom-ferdi-server)
- [Features](#features)
- [Setup](#setup)
@@ -16,7 +16,7 @@ Official Server software for the [Ferdi Messaging Browser](https://getferdi.com)
- [Transferring user data](#transferring-user-data)
- [Creating and using custom recipes](#creating-and-using-custom-recipes)
- [Listing custom recipes](#listing-custom-recipes)
- - [Contributing to ferdi-server's development](#contributing-to-ferdi-servers-development)
+ - [Contributing to Ferdi-server's development](#contributing-to-ferdi-servers-development)
- [License](#license)
## Why use a custom Ferdi server?
@@ -30,7 +30,7 @@ If you are not interested in doing this you can use our official instance of Fer
- [x] Workspace support
- [x] Functioning service store
- [x] User dashboard
-- [x] Export/import data to other ferdi-servers
+- [x] Export/import data to other Ferdi-servers
- [ ] Password recovery
- [ ] Recipe update
@@ -39,7 +39,9 @@ If you are not interested in doing this you can use our official instance of Fer
The easiest way to set up Ferdi server on your server is with Docker.
The 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).
-After setting up the docker container we recommend you to set up an NGINX reverse proxy to access ferdi-server outside of your home network and protect it with an SSL certificate.
+After 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.
+
+**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.
1. Pull the Docker image
@@ -126,26 +128,26 @@ Please refer to