numbus/numbus
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Moving to a web based configurator. Huge changes. Surely a lot of bugfixing to do.

Browse Source
This commit is contained in:
Raphaël Numbus
2026-03-28 21:49:24 +01:00
parent e67dc12f42
commit 29d7eac981
19 changed files with 1469 additions and 563 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/numbus-server/configuration/services/automatic_ssl_certs.md
+7
View File
@@ -0,0 +1,7 @@
# Numbus Server documentation
## 🚦 Configuring Traefik
| Variable | Description | Values | Default |
| -------- | ----------- | ------ | --------- |
| CLOUDFLARE_DNS_API_TOKEN | The Cloudflare API token with "Zone.DNS" permissions, used for SSL certificate generation. | "bA7hdvCOuXGytlNKohi3ZGtlVpf5CHpLuCMiJrE" | null. Not setting this variable will cause the script to fail. |
docs/numbus-server/configuration/services/custom_subdomain.md
+34
View File
@@ -0,0 +1,34 @@
# Numbus Server documentation
## 🌍 Using custom subdomains
**By default**, the name of the service will be the **subdomain**. For example, nextcloud will get the "nextcloud" subdomain. You **should change** those subdomains :
- If you are using the **same domain name** for **multiple servers** (avoids conflicts)
- If you just **want** to change them
<br>
> To change the subdomain of a service, just create a variable in the **.conf** configuration file like so : **<THE_SERVICE>_SUBDOMAIN="your_custom_subdomain".** If you are you are unsure of the correct service name, check the list below.
## Variables list
| Variable | Default |
| --------- | ------ |
| PI_HOLE_SUBDOMAIN | pi-hole |
| ADGUARD_SUBDOMAIN | adguard |
| CRAFFY_SUBDOMAIN | crafty |
| FRIGATE_SUBDOMAIN | frigate |
| GITEA_SUBDOMAIN | gitea |
| HOME_ASSISTANT_SUBDOMAIN | home-assistant |
| HOMEPAGE_SUBDOMAIN | homepage |
| IMMICH_SUBDOMAIN | immich |
| IT_TOOLS_SUBDOMAIN | it-tools |
| JELLYFIN_SUBDOMAIN | jellyfin |
| N8N_SUBDOMAIN | n8n |
| NETBOOTXYZ_SUBDOMAIN | netbootxyz |
| NEXTCLOUD_SUBDOMAIN | nextcloud |
| NTFY_SUBDOMAIN | ntfy |
| ODOO_SUBDOMAIN | odoo |
| PASSBOLT_SUBDOMAIN | passbolt |
| UPTIME_KUMA_SUBDOMAIN | uptime-kuma |
| VSCODIUM_SUBDOMAIN | vscodium |
docs/numbus-server/configuration/services/index.md
+5 -5
View File
@@ -4,11 +4,11 @@
| Variable | Description | Values | Default |
| -------- | ----------- | ------ | --------- |
| DOMAIN_NAME | The domain name that will be used to access the different services. | your-domain.com | |
| 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.md) | Custom [subdomain](../custom_subdomain.md) 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_subdomain.md) | Custom [subdomain](../custom_subdomain.md)s 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
@@ -37,7 +37,7 @@ This is the list of **all the available apps** that can be enabled on the numbus
## System services list
| Name | Description | Additional settings ? |
| Name | Description | Additional settings |
| -------- | ----------- | ------ |
| clamav | Open-source anti-virus software. | No |
| virtualization | Run Virtual Machines (KVM/QEMU). | No |
| clamav | Open-source anti-virus software. | |
| virtualization | Run Virtual Machines (KVM/QEMU). | |