Added documentation for the numbus-server

This commit is contained in:
Raphaël Numbus
2026-03-18 13:26:13 +01:00
parent d09e261b14
commit b156bf443e
20 changed files with 581 additions and 161 deletions
+19
View File
@@ -0,0 +1,19 @@
# Documentation
## ✏️ Filling the configuration file
You can deploy the numbus-server without using a configuration file, **but I would strongly advise it** as it diminishes the risk of **typos** when providing credentials. It also creates a file that you can **keep**, **reuse**, **consult** whenever you are **in doubt** about a certain setting.
> 🚀 Let's fill this configuration file !
The configuration file is divided into **multiple categories**. Some of them are **optional**, some are **mandatory**. Here is the list of categories :
| Category | Available variables |
| -------- | ------------------ |
| [Live target settings](./live_target.md) | 2 |
| [Server settings](/.server.md) | 7 |
| [Mail settings](./mail.md) | 4 |
| [Traefik settings](./automatic_ssl_certs.md) | 1 |
| [Network settings](./network.md) | 3 |
| [Services selection](./services/index.md) | 5 |
| [Script settings](./script.md) | 1 |