aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Bennett <hello@vantezzen.io>2020-03-10 15:11:03 +0100
committerLibravatar Bennett <hello@vantezzen.io>2020-03-10 15:11:03 +0100
commitbca1ffbd601a19245717752df9f312172aaa3bf8 (patch)
tree6c73a7554d651de1fcc3fb04c11868675c2d858d /README.md
parentMerge branch 'master' of https://github.com/getferdi/server (diff)
downloadferdium-server-bca1ffbd601a19245717752df9f312172aaa3bf8.tar.gz
ferdium-server-bca1ffbd601a19245717752df9f312172aaa3bf8.tar.zst
ferdium-server-bca1ffbd601a19245717752df9f312172aaa3bf8.zip
Add "IS_REGISTRATION_ENABLED" option
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6aa2d02..9b39460 100644
--- a/README.md
+++ b/README.md
@@ -76,7 +76,8 @@ After setting up the docker container we recommend you to set up an NGINX revers
76 - DB_PASSWORD=<yourdbpass> 76 - DB_PASSWORD=<yourdbpass>
77 - DB_DATABASE=<yourdbdatabase> 77 - DB_DATABASE=<yourdbdatabase>
78 - IS_CREATION_ENABLED=true/false 78 - IS_CREATION_ENABLED=true/false
79 - CONNECT_WITH_FRANZ=true/flase 79 - CONNECT_WITH_FRANZ=true/false
80 - IS_REGISTRATION_ENABLED=true/false
80 volumes: 81 volumes:
81 - <path to data>:/config 82 - <path to data>:/config
82 - <path to database>:/usr/src/app/database 83 - <path to database>:/usr/src/app/database
@@ -106,6 +107,7 @@ For more information on configuring the Docker image, visit the Docker image rep
106## Configuration 107## Configuration
107franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings: 108franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings:
108- `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes) 109- `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes)
110- `IS_REGISTRATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the creation of new user accounts
109- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, ferdi-server can: 111- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, ferdi-server can:
110 - Show the full Franz recipe library instead of only custom recipes 112 - Show the full Franz recipe library instead of only custom recipes
111 - Import Franz accounts 113 - Import Franz accounts