Skip to content

Commit f054a3e

Browse files
authored
Docs: Extend pages for better findably and readability (#1517)
1 parent f87f381 commit f054a3e

File tree

11 files changed

+70
-16
lines changed

11 files changed

+70
-16
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Manually Approving New Users
2+
3+
Mbin allows you to manually approve new users before they can log into your server.
4+
5+
If you want to manually approve users before they can log into your server,
6+
you can either tick the 'New users have to be approved by an admin before they can log in' checkbox in the admin settings.
7+
Or put this in the `.env` file:
8+
9+
```ini
10+
MBIN_NEW_USERS_NEED_APPROVAL=true
11+
```
12+
13+
The admin will then see a new 'Signup request' panel in the admin interface where new user registrations will appear pending your approval or denial.
14+
15+
When an administrator approves or denies an user application, the user will receive an email notification about the decision.

docs/02-admin/03-optional-features/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Like setting-up:
77
- [Mercure](01-mercure.md) - Mercure is used to provide real-time data from the server towards the clients.
88
- [Single sign-on (SSO)](02-sso.md) - SSO can be configured to allow registrations via other SSO providers.
99
- [Captcha](03-captcha.md) - Captcha protection against spam and anti-bot.
10-
- [Image metadata cleaning](04-image_metadata_cleaning.md) - Clean-up and remove metadata from images using `exiftool`.
11-
- [S3 storage](05-s3_storage.md) - Configure an object storage service (S3) compatible bucket for storing images.
10+
- [User application approval](04-user_application.md) - Manually approve users before they can log into your server (eg. to avoid spam accounts).
11+
- [Image metadata cleaning](05-image_metadata_cleaning.md) - Clean-up and remove metadata from images using `exiftool`.
12+
- [S3 storage](06-s3_storage.md) - Configure an object storage service (S3) compatible bucket for storing images.

docs/02-admin/03-optional-features/user_application.md

-10
This file was deleted.
+11-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
# Troubleshooting
1+
# Troubleshooting
2+
3+
For troubleshooting, see also the [FAQ page we have created](../FAQ.md)!
4+
5+
And to get more (debug) **logging output** see:
6+
7+
- [Bare metal setup troubleshooting page](./01-bare_metal.md)
8+
9+
Or:
10+
11+
- [Docker troubleshooting page](./02-docker.md)

docs/02-admin/FAQ.md

+2
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,8 @@ _Hint:_ Most messages that are stored in the database are most likely in the `fa
152152

153153
You can find the Mbin logging in the `var/log/` directory from the root folder of the Mbin installation. When running production the file is called `prod-{YYYY-MM-DD}.log`, when running development the log file is called `dev-{YYYY-MM-DD}.log`.
154154

155+
See also [troubleshooting (bare metal)](./05-troubleshooting/01-bare_metal.md).
156+
155157
## Should I run development mode?
156158

157159
**NO!** Try to avoid running development mode when you are hosting our own _public_ instance. Running in development mode can cause sensitive data to be leaked, such as secret keys or passwords (eg. via development console). Development mode will log a lot of messages to disk (incl. stacktraces).

docs/02-admin/README.md

+36
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,43 @@
22

33
Welcome to the admin section of the Mbin documentation.
44

5+
6+
## Installation
7+
58
You can install Mbin via:
69

710
- [Bare metal](01-installation/01-bare_metal.md) (recommended for now)
811
- or via [Docker](01-installation/02-docker.md)
12+
13+
## Configuration
14+
15+
- [Mbin configuration files (Symfony)](02-configuration/01-mbin_config_files.md)
16+
- [Nginx configuration](02-configuration/02-nginx.md)
17+
- [Let's Encrypt](02-configuration/03-lets_encrypt.md)
18+
- [PostgreSQL database](02-configuration/04-postgresql.md)
19+
- [Redis, KeyDB, Valkey cache configuration](02-configuration/05-redis.md)
20+
21+
## Optional features
22+
23+
Optional features like Mercure, SSO, Captcha, Image metadata cleaning or S3 storage:
24+
25+
[More information on the optional features page](./03-optional-features/README.md)
26+
27+
## Running Mbin
28+
29+
- [First setup](04-running-mbin/01-first_setup.md)
30+
- [Backup](04-running-mbin/02-backup.md)
31+
- [Upgrades](04-running-mbin/03-upgrades.md)
32+
- [Symfony messenger](04-running-mbin/04-messenger.md)
33+
- [Command-line maintenance tool (CLI)](04-running-mbin/05-cli.md)
34+
35+
## Troubleshooting
36+
37+
See [FAQ](FAQ.md). And how-to get logging information see either:
38+
39+
- [Bare metal troubleshooting](05-troubleshooting/01-bare_metal.md)
40+
- [Docker troubleshooting](05-troubleshooting/02-docker.md)
41+
42+
## FAQ
43+
44+
See [Frequently Asked Questions (FAQ) page](./FAQ.md).

docs/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
We split up the documentation for:
44

5-
- [Users](01-user/README.md) - User guide
5+
- [End users](01-user/README.md) - End user guide
66
- [Admins](02-admin/README.md) - How-to guides for admins
7-
- [Contributing](03-contributing/README.md) - How to contribute to the project
8-
- [App developers](04-app_developers/README.md) - How to use Mbin API
7+
- [Contributing](03-contributing/README.md) - How-to contribute to the Mbin project
8+
- [App developers](04-app_developers/README.md) - How-to use the Mbin API

0 commit comments

Comments
 (0)