Added documentation for the numbus-server

2026-03-18 13:26:13 +01:00
parent d09e261b14
commit b156bf443e
20 changed files with 581 additions and 161 deletions
@@ -0,0 +1,13 @@
+# Documentation
+
+## ⛏️ Configuring Crafty Controller
+
+To access your Minecraft server, **ports** need to be **open on the firewall**. In order to **minimize** the number of open ports and thus reduce **risks**, the numbus-server will only open a necessary number of ports that matches the number of minecraft. **Most people** should set the number of servers to **1** of their favorite version.
+
+These option **only configure networking** and **won't** create the Minecraft server for you. You will have to do it in Crafty's interface.
+
+| Variable | Description | Values | Default |
+| -------- | ----------- | ------ | --------- |
+| DYNMAP_ENABLED | Enables the Dynmap feature for Minecraft servers. | "true" or "false" | "false" |
+| WANTED_NUMBER_OF_JAVA_MINECRAFT_SERVERS | The number of Java Edition Minecraft servers you plan on creating. | "0", "1", ..., "100" | "0" |
+| WANTED_NUMBER_OF_BEDROCK_MINECRAFT_SERVERS | The number of Bedrock Edition Minecraft servers you plan on creating. | "0", "1", ..., "100" | "0" |
@@ -0,0 +1,45 @@
+# Documentation
+
+## 🛠️ Configuring the server's services
+
+| Variable | Description | Values | Default |
+| -------- | ----------- | ------ | --------- | 
+| SELECTED_DNS_SERVICE | The DNS service to install (AdBlocking). | ( "pi-hole" ), ( "adguard" ) | ( "pi-hole" ) |
+| SELECTED_WEB_APPLICATIONS | The list of web applications to install. | ( "nextcloud" ), ( "homepage" jellyfin" "it-tools" "netbootxyz" ), ... [see the full list below](./index.md#web-applications-list) |  |
+| SELECTED_SYSTEM_SERVICES | The list of system services to install. | ( "clamav" ), ( "virtualization" "clamav" ), ... [see the full list below](./index.md#system-services-list) |  |
+| SELECTED_DNS_SERVICE_SUBDOMAIN | Custom subdomain for the DNS service. | "my-dns" | Will be the name of the service. I.e. pi-hole.your-domain.com or adguard.your-domain.com |
+| SELECTED_WEB_APPLICATIONS_SUBDOMAIN | Custom subdomains for the web applications (must match the order of SELECTED_WEB_APPLICATIONS). | "my-cloud", "my-photos" | Will be the name of the service. I.e. nextcloud.your-domain.com, immich.your-domain.com, ... |
+
+## Web applications list
+
+This is the list of **all the available apps** that can be enabled on the numbus-server. You can choose as many as you want, just **keep in mind** that enabling more apps will be more resource **intensive** and consume more power.
+
+| Name | Description | Additional settings ? |
+| -------- | ----------- | ------ |
+| pi-hole | Simple, fully open network-wide Ad Blocker. | No |
+| adguard | Feature-rich network-wide Ad Blocker. | No |
+| crafty | Minecraft server(s) manager. | [Yes](./crafty.md) |
+| frigate | NVR with real-time local object detection. | No |
+| gitea | Painless self-hosted Git service. | No |
+| home-assistant | Open source home automation. | No |
+| homepage | A modern, secure, highly customizable dashboard. | No |
+| immich | High performance self-hosted photo/video management. | No |
+| it-tools | Collection of online tools for developers. | No |
+| jellyfin | The Free Software Media System. | No |
+| n8n | Workflow automation tool. | No |
+| netbootxyz | Network boot operating system installers. | No |
+| nextcloud | Self-hosted collaboration platform. | No |
+| ntfy | Send push notifications via HTTP. | No |
+| odoo | Open Source ERP and CRM. | No |
+| passbolt | Open source password manager. | No |
+| uptime-kuma | Self-hosted monitoring tool. | No |
+| vscodium | VS Code in your browser. | No |
+| clamav | Open-source anti-virus. | No |
+| virtualization | Run Virtual Machines (KVM/QEMU). | No |
+
+## System services list
+
+| Name | Description | Additional settings ? |
+| -------- | ----------- | ------ |
+| clamav | Open-source anti-virus software. | No |
+| virtualization | Run Virtual Machines (KVM/QEMU). | No |