Raphaël Numbus
43 lines
3.3 KiB
Markdown
43 lines
3.3 KiB
Markdown
# Numbus Server 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.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**.
|
|
|
|
| Name | Description | Additional settings |
|
|
| -------- | ----------- | ------ |
|
|
| 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
|
|
|
|
| Name | Description | Additional settings ? |
|
|
| -------- | ----------- | ------ |
|
|
| clamav | Open-source anti-virus software. | No |
|
|
| virtualization | Run Virtual Machines (KVM/QEMU). | No | |