diff --git a/docs/numbus-server/configuration/automatic_ssl_certs.md b/docs/numbus-server/configuration/automatic_ssl_certs.md index 3df10c0..5486db2 100644 --- a/docs/numbus-server/configuration/automatic_ssl_certs.md +++ b/docs/numbus-server/configuration/automatic_ssl_certs.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ## 🚦 Configuring Traefik diff --git a/docs/numbus-server/configuration/custom_subdomain.md b/docs/numbus-server/configuration/custom_subdomain.md new file mode 100644 index 0000000..b110052 --- /dev/null +++ b/docs/numbus-server/configuration/custom_subdomain.md @@ -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 + +
+ +> To change the subdomain of a service, just create a variable in the **.conf** configuration file like so : **_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 | \ No newline at end of file diff --git a/docs/numbus-server/configuration/index.md b/docs/numbus-server/configuration/index.md index f0dae2e..a88d970 100644 --- a/docs/numbus-server/configuration/index.md +++ b/docs/numbus-server/configuration/index.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ## ✏️ Filling the configuration file diff --git a/docs/numbus-server/configuration/live_target.md b/docs/numbus-server/configuration/live_target.md index 93c1787..f351f45 100644 --- a/docs/numbus-server/configuration/live_target.md +++ b/docs/numbus-server/configuration/live_target.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ### 📦 Configuring the target settings diff --git a/docs/numbus-server/configuration/mail.md b/docs/numbus-server/configuration/mail.md index fc69931..b4855a1 100644 --- a/docs/numbus-server/configuration/mail.md +++ b/docs/numbus-server/configuration/mail.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ## 📬 Configuring the mail settings diff --git a/docs/numbus-server/configuration/network.md b/docs/numbus-server/configuration/network.md index 665aa6a..86e8669 100644 --- a/docs/numbus-server/configuration/network.md +++ b/docs/numbus-server/configuration/network.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ## 🛜 Configuring the server's network settings diff --git a/docs/numbus-server/configuration/script.md b/docs/numbus-server/configuration/script.md index 2eb5224..ced492b 100644 --- a/docs/numbus-server/configuration/script.md +++ b/docs/numbus-server/configuration/script.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ## 📜 Configuring the script's settings diff --git a/docs/numbus-server/configuration/server.md b/docs/numbus-server/configuration/server.md index ddc7fd7..c4965e9 100644 --- a/docs/numbus-server/configuration/server.md +++ b/docs/numbus-server/configuration/server.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ## ⚙️ Configuring the server settings diff --git a/docs/numbus-server/configuration/services/crafty.md b/docs/numbus-server/configuration/services/crafty.md index 2f940c0..0ed5cfc 100644 --- a/docs/numbus-server/configuration/services/crafty.md +++ b/docs/numbus-server/configuration/services/crafty.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ## ⛏️ Configuring Crafty Controller diff --git a/docs/numbus-server/configuration/services/index.md b/docs/numbus-server/configuration/services/index.md index 666dc63..44b8713 100644 --- a/docs/numbus-server/configuration/services/index.md +++ b/docs/numbus-server/configuration/services/index.md @@ -1,4 +1,4 @@ -# Documentation +# Numbus Server documentation ## 🛠️ Configuring the server's services @@ -7,35 +7,33 @@ | 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, ... | +| 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 -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. +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 ? | +| 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 | +| pi-hole | Simple, fully open network-wide Ad Blocker. | [subdomain](../custom_subdomain.md) | +| adguard | Feature-rich network-wide Ad Blocker. | [subdomain](../custom_subdomain.md) | +| crafty | Minecraft server(s) manager. | [subdomain](../custom_subdomain.md), [settings](./crafty.md) | +| frigate | NVR with real-time local object detection. | [subdomain](../custom_subdomain.md) | +| gitea | Painless self-hosted Git service. | [subdomain](../custom_subdomain.md) | +| home-assistant | Open source home automation. | [subdomain](../custom_subdomain.md) | +| homepage | A modern, secure, highly customizable dashboard. | [subdomain](../custom_subdomain.md) | +| immich | High performance self-hosted photo/video management. | [subdomain](../custom_subdomain.md) | +| it-tools | Collection of online tools for developers. | [subdomain](../custom_subdomain.md) | +| jellyfin | The Free Software Media System. | [subdomain](../custom_subdomain.md) | +| n8n | Workflow automation tool. | [subdomain](../custom_subdomain.md) | +| netbootxyz | Network boot operating system installers. | [subdomain](../custom_subdomain.md) | +| nextcloud | Self-hosted collaboration platform. | [subdomain](../custom_subdomain.md) | +| ntfy | Send push notifications via HTTP. | [subdomain](../custom_subdomain.md) | +| odoo | Open Source ERP and CRM. | [subdomain](../custom_subdomain.md) | +| passbolt | Open source password manager. | [subdomain](../custom_subdomain.md) | +| uptime-kuma | Self-hosted monitoring tool. | [subdomain](../custom_subdomain.md) | +| vscodium | VS Code in your browser. | [subdomain](../custom_subdomain.md) | ## System services list