From c6abfa27c12ad346242766f0c0ef51bd931dc424 Mon Sep 17 00:00:00 2001 From: Tobias Diekershoff Date: Fri, 9 Mar 2018 09:53:08 +0100 Subject: [PATCH 1/2] documentation of invitation based registration --- doc/Settings.md | 15 +++++++++++++++ doc/de/Settings.md | 14 ++++++++++++++ doc/htconfig.md | 1 + 3 files changed, 30 insertions(+) diff --git a/doc/Settings.md b/doc/Settings.md index a574e0675..bd7781c6a 100644 --- a/doc/Settings.md +++ b/doc/Settings.md @@ -57,6 +57,21 @@ The `vier` theme for instance is mobile friendly. ### Registration +#### Register policy + +With this drop down selector you can set the nodes registration policy. +You can chose between the following modes: + +* **open**: Everybody can register a new account and start using it right away. +* **requires approval**: Everybody can register a new account, but the admin has to approve it before it can be used. +* **closed**: No new registrations are possible. + +##### Invitation based registry + +Additionally to the setting in the admin panel, you can devide if registrations are only possible using an invitation code or not. +To enable invitation based registration, you have to set the `invitation_only` setting in the [.htconfig.php](/doc/htconfig) file. +If you want to use this method, the registration policy has to be set to either *open* or *requires approval*. + #### Check Full Names You may find a lot of spammers trying to register on your site. diff --git a/doc/de/Settings.md b/doc/de/Settings.md index 1c7a48743..4da6cd8c7 100644 --- a/doc/de/Settings.md +++ b/doc/de/Settings.md @@ -54,6 +54,20 @@ Das `vier` Theme z.B. unterstützt kleine Anzeigen und benötigt kein zusätzlic ### Registrierung +#### Registrierungsmethode + +Diese Einstellung regelt die Art der Registrierung. +Dabei kannst du zwischen den folgenden Optionen wählen: + +* **Offen**: Jeder kann ein neues Nutzerkonto anlegen und es sofort benutzen. +* **Bedarf der Zustimmung**: Jeder kann ein Nutzerkonto anlegen. Dieses muss allerdings durch den Admin freigeschaltet werden, bevor es verwendet werden kann. +* **Geschlossen**: Es können keine weiteren Nutzerkonten angelegt werden. + +##### Einladungen + +Zusätzlich zu den oben genannten Möglichkeiten, kann die Registrierung eines neuen Nutzerkontos an eine Einladung durch einen bestehenden Nutzer gekoppelt werden. +Hierzu muss in der [.htconfig.php](/doc/htconfig) Datei die Option `invitation_only` aktiviert und als Registrierungsmethode entweder *Offen* oder *Bedarf der Zustimmung* gewählt werden. + #### Namen auf Vollständigkeit überprüfen Es kann vorkommen, dass viele Spammer versuchen, sich auf deiner Seite zu registrieren. diff --git a/doc/htconfig.md b/doc/htconfig.md index 3a482742d..a19a92a4a 100644 --- a/doc/htconfig.md +++ b/doc/htconfig.md @@ -47,6 +47,7 @@ Example: To set the automatic database cleanup process add this line to your .ht * **ignore_cache** (Boolean) - For development only. Disables the item cache. * **instances_social_key** - Key to the API of https://instances.social which retrieves data about mastodon servers. See https://instances.social/api/token to get an API key. * **ipv4_resolve** (Boolean) - Resolve IPV4 addresses only. Don't resolve to IPV6. Default value is false. +* **invitation_only** (Boolean) - If set true registration is only possible after a current member of the node has send an invitation. Default is false. * **like_no_comment** (Boolean) - Don't update the "commented" value of an item when it is liked. * **local_block** (Boolean) - Used in conjunction with "block_public". * **local_search** (Boolean) - Blocks search for users who are not logged in to prevent crawlers from blocking your system. From d3b872d58928d829006b7459d3f0318fc4b8485e Mon Sep 17 00:00:00 2001 From: Tobias Diekershoff Date: Fri, 9 Mar 2018 10:06:53 +0100 Subject: [PATCH 2/2] help not doc --- doc/Settings.md | 2 +- doc/de/Settings.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/Settings.md b/doc/Settings.md index bd7781c6a..5f41bb83b 100644 --- a/doc/Settings.md +++ b/doc/Settings.md @@ -69,7 +69,7 @@ You can chose between the following modes: ##### Invitation based registry Additionally to the setting in the admin panel, you can devide if registrations are only possible using an invitation code or not. -To enable invitation based registration, you have to set the `invitation_only` setting in the [.htconfig.php](/doc/htconfig) file. +To enable invitation based registration, you have to set the `invitation_only` setting in the [.htconfig.php](/help/htconfig) file. If you want to use this method, the registration policy has to be set to either *open* or *requires approval*. #### Check Full Names diff --git a/doc/de/Settings.md b/doc/de/Settings.md index 4da6cd8c7..e3f5dbe84 100644 --- a/doc/de/Settings.md +++ b/doc/de/Settings.md @@ -66,7 +66,7 @@ Dabei kannst du zwischen den folgenden Optionen wählen: ##### Einladungen Zusätzlich zu den oben genannten Möglichkeiten, kann die Registrierung eines neuen Nutzerkontos an eine Einladung durch einen bestehenden Nutzer gekoppelt werden. -Hierzu muss in der [.htconfig.php](/doc/htconfig) Datei die Option `invitation_only` aktiviert und als Registrierungsmethode entweder *Offen* oder *Bedarf der Zustimmung* gewählt werden. +Hierzu muss in der [.htconfig.php](/help/htconfig) Datei die Option `invitation_only` aktiviert und als Registrierungsmethode entweder *Offen* oder *Bedarf der Zustimmung* gewählt werden. #### Namen auf Vollständigkeit überprüfen