aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar maTh <math-home@web.de> 2021-12-26 12:47:17 +0100
committerGravatar GitHub <noreply@github.com> 2021-12-26 12:47:17 +0100
commit078dc65cbc21012eb9cfd2a14398f9ee3f26fcb7 (patch)
treea5c904779d64ec539ed66303033d81c7b643d528 /docs
parent20c8382c250bc21cb16f04beded665bf137b6bf0 (diff)
Improved manual: User Management/User registration (#4083)
* Draft 1 of Default User page * Draft1 of User Management page * Update 01_Index.md * Update 12_User_management.md * fix failing pipeline * Apply suggestions from code review Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/en/admins/01_Index.md1
-rw-r--r--docs/en/admins/12_User_management.md35
-rw-r--r--docs/en/admins/13_Default_user.md24
3 files changed, 60 insertions, 0 deletions
diff --git a/docs/en/admins/01_Index.md b/docs/en/admins/01_Index.md
index c4f3cee7f..9842cba8f 100644
--- a/docs/en/admins/01_Index.md
+++ b/docs/en/admins/01_Index.md
@@ -8,6 +8,7 @@ Learn how to install, update, and backup FreshRSS, as well as how to use the com
## Tutorials and Examples
+* [User management](12_User_management.md)
* [Backing up FreshRSS](05_Backup.md)
* [Installing themes](11_Themes.md)
* [Installation on Debian 9/Ubuntu 16.04](06_LinuxInstall.md)
diff --git a/docs/en/admins/12_User_management.md b/docs/en/admins/12_User_management.md
new file mode 100644
index 000000000..e2c19b467
--- /dev/null
+++ b/docs/en/admins/12_User_management.md
@@ -0,0 +1,35 @@
+# User Management
+
+## User list
+
+Settings page: `Administation` -> `Manage Users`.
+
+The [default user](13_Default_user.md) is marked with italic letters.
+
+## Create new user
+
+Settings page: `Administation` → `Manage Users`.
+
+For a new user the following information is necessary:
+* language
+* username
+* is it an administrator account?
+* password
+
+If in the `System configuration` the `Force email address validation` is enabled, then the email address input is shown and mandatory.
+
+## User registration form
+
+New users could use the self registration form in the frontend.
+
+The user registration form is available via the login form, when the maximum number of accounts is smaller than the number of created accounts (Set up in `Administration` → `System configuration`). If the maximum number of accounts is 0, than there is no limit on the number of user accounts.
+
+If in the `System configuration` the `Force email addres validation` is enabled, than the email address input is shown and mandatory.
+
+It is optional to have a `Terms of Service` (`ToS`). If ToS is enabled, then it is mandatory to check it for registration.
+
+### Enable Terms of Service (ToS)
+
+Create a file `tos.html` in `./data`.
+
+Example of TOS: see `./data/tos.example.html`
diff --git a/docs/en/admins/13_Default_user.md b/docs/en/admins/13_Default_user.md
new file mode 100644
index 000000000..946d53814
--- /dev/null
+++ b/docs/en/admins/13_Default_user.md
@@ -0,0 +1,24 @@
+# Default User
+
+Currently, we have one `main user`, also called `default user`, or `admin`. All the others are `regular users`.
+
+The default user is the first created user within the install routine.
+
+## Manage
+
+The default user is always an administrator.
+
+It is impossible to demote or disable the user.
+
+## Anonymous reading mode
+
+The default user is used for the anonymous reading.
+
+How to enable the anonymous reading mode:
+* go to settings `Administration` → `Authentication`
+* enable the checkbox of `Allow anonymous reading of the default user's articles`
+* when no user is logged in then the feeds of the default user is shown
+
+## Change the default user
+
+There is no UI for changing the default user, but a CLI (`./cli/reconfigure.php --default_user YourNewAdmin`) is provided. It can also be changed manually by editing the text file `./FreshRSS/data/config.php` and changing `'default_user' => 'alice'`, to the desired user.