aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar vantezzen <properly@protonmail.com>2019-09-03 10:34:42 +0200
committerLibravatar vantezzen <properly@protonmail.com>2019-09-03 10:34:42 +0200
commit6a9a42e50dfc9e7811e0b75da6b3ea456372d75e (patch)
treefdf4df53ba7484e709b144ae015213e4e0a180e6 /README.md
parentAdd legal documents to account import page (diff)
downloadferdium-server-6a9a42e50dfc9e7811e0b75da6b3ea456372d75e.tar.gz
ferdium-server-6a9a42e50dfc9e7811e0b75da6b3ea456372d75e.tar.zst
ferdium-server-6a9a42e50dfc9e7811e0b75da6b3ea456372d75e.zip
Add CONNECT_WITH_FRANZ option
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 74e1e22..b686fad 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,10 @@ Unofficial Franz server replacement for use with the Ferdi Client.
22 22
23## Configuration 23## Configuration
24franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings: 24franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings:
25- `IS_CREATION_ENABLED` (`true` or `false`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes) 25- `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes)
26- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, ferdi-server can:
27 - Show the full Franz recipe library instead of only custom recipes
28 - Import Franz accounts
26 29
27## Importing your Franz account 30## Importing your Franz account
28ferdi-server allows you to import your full Franz account, including all its settings. 31ferdi-server allows you to import your full Franz account, including all its settings.