Update docs with better config + installation instructions (#300)

* start reworking some documentation

* fuller documentation  + better docs structure
This commit is contained in:
tobi
2021-11-14 16:54:23 +01:00
committed by GitHub
parent 38e100a7a4
commit d81a123473
21 changed files with 718 additions and 331 deletions

View File

@@ -0,0 +1,27 @@
# Accounts
## Settings
```yaml
###########################
##### ACCOUNTS CONFIG #####
###########################
# Config pertaining to creation and maintenance of accounts on the server, as well as defaults for new accounts.
accounts:
# Bool. Do we want people to be able to just submit sign up requests, or do we want invite only?
# Options: [true, false]
# Default: true
openRegistration: true
# Bool. Do sign up requests require approval from an admin/moderator before an account can sign in/use the server?
# Options: [true, false]
# Default: true
requireApproval: true
# Bool. Are sign up requests required to submit a reason for the request (eg., an explanation of why they want to join the instance)?
# Options: [true, false]
# Default: true
reasonRequired: true
```