From dc3665e4ac52fffb01fbef789b34fe715f3e025d Mon Sep 17 00:00:00 2001 From: jackspiering <46534141+jackspiering@users.noreply.github.com> Date: Tue, 3 Feb 2026 21:34:24 +0100 Subject: [PATCH] Refactor Beszel service structure: separate Hub and Agent configurations, update README, and remove deprecated files --- README.md | 3 ++- services/{beszel/agent => beszel-agent}/.env | 0 services/beszel-agent/README.md | 11 +++++++++++ .../agent => beszel-agent}/compose.yaml | 0 services/{beszel/hub => beszel-hub}/.env | 0 services/beszel-hub/README.md | 11 +++++++++++ .../{beszel/hub => beszel-hub}/compose.yaml | 0 services/beszel/README.md | 19 ------------------- 8 files changed, 24 insertions(+), 20 deletions(-) rename services/{beszel/agent => beszel-agent}/.env (100%) create mode 100644 services/beszel-agent/README.md rename services/{beszel/agent => beszel-agent}/compose.yaml (100%) rename services/{beszel/hub => beszel-hub}/.env (100%) create mode 100644 services/beszel-hub/README.md rename services/{beszel/hub => beszel-hub}/compose.yaml (100%) delete mode 100644 services/beszel/README.md diff --git a/README.md b/README.md index 14932ba..85e9263 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,8 @@ If you would like to add your own config, you can use the [service-template](tem | 📈 Service | 📝 Description | 🔗 Link | | ----------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------- | -| 📉 **Beszel** | A lightweight server monitoring hub with historical data, Docker stats, and alerts. | [Details](services/beszel) | +| 📉 **Beszel Hub** | The Beszel Hub provides historical monitoring data, Docker stats, and alerts. | [Details](services/beszel-hub) | +| 🛰️ **Beszel Agent** | The Beszel Agent collects stats and reports them back to the Hub. | [Details](services/beszel-agent) | | 🔎 **Portracker** | A simple, self-hosted port monitoring and tracking tool for auditing open ports. | [Details](services/portracker) | | 🚀 **Speedtest Tracker** | A self-hosted tool to monitor and log internet speed tests with detailed visualizations. | [Details](services/speedtest-tracker) | | 📊 **Uptime Kuma** | A self-hosted monitoring tool like "Uptime Robot". | [Details](services/uptime-kuma) | diff --git a/services/beszel/agent/.env b/services/beszel-agent/.env similarity index 100% rename from services/beszel/agent/.env rename to services/beszel-agent/.env diff --git a/services/beszel-agent/README.md b/services/beszel-agent/README.md new file mode 100644 index 0000000..9913020 --- /dev/null +++ b/services/beszel-agent/README.md @@ -0,0 +1,11 @@ +# Beszel Agent with Tailscale Sidecar Configuration + +This Docker Compose configuration integrates the [Beszel](https://github.com/henrygd/beszel) Agent with Tailscale in a sidecar setup to enhance secure communication over a private Tailscale network. By utilizing Tailscale, this configuration ensures that the Agent's communication with the Hub remains secure and private within your Tailscale network. Thanks to @[henrygd](https://github.com/henrygd) for the tool development. + +## Beszel Agent + +The Beszel Agent is the client-side component that connects to the Hub to send and receive messages. Multiple agents can connect to a single Hub, enabling secure communication across different devices. The Agent also benefits from the Tailscale sidecar, ensuring that its communication with the Hub is conducted over a secure, private network. + +## Configuration Overview + +In this setup, the `tailscale` service runs Tailscale, which manages secure networking for the Beszel Agent service. The Agent service connects to the Tailscale network stack using Docker's `network_mode: service:` configuration. This setup guarantees that the Agent's communication channels are only accessible through the Tailscale network, providing an extra layer of security and privacy. diff --git a/services/beszel/agent/compose.yaml b/services/beszel-agent/compose.yaml similarity index 100% rename from services/beszel/agent/compose.yaml rename to services/beszel-agent/compose.yaml diff --git a/services/beszel/hub/.env b/services/beszel-hub/.env similarity index 100% rename from services/beszel/hub/.env rename to services/beszel-hub/.env diff --git a/services/beszel-hub/README.md b/services/beszel-hub/README.md new file mode 100644 index 0000000..b2e4035 --- /dev/null +++ b/services/beszel-hub/README.md @@ -0,0 +1,11 @@ +# Beszel Hub with Tailscale Sidecar Configuration + +This Docker Compose configuration integrates the [Beszel](https://github.com/henrygd/beszel) Hub with Tailscale in a sidecar setup to enhance secure communication over a private Tailscale network. By utilizing Tailscale, this configuration ensures that all communication handled by the Hub remains secure and private within your Tailscale network. Thanks to @[henrygd](https://github.com/henrygd) for the tool development. + +## Beszel Hub + +The Beszel Hub is the core component responsible for routing messages between agents and managing the overall communication flow. In this configuration, the Hub runs in its own Docker service and is secured by the Tailscale sidecar, ensuring that all traffic to and from the Hub is encrypted and restricted to your Tailscale network. + +## Configuration Overview + +In this setup, the `tailscale` service runs Tailscale, which manages secure networking for the Beszel Hub service. The Hub service connects to the Tailscale network stack using Docker's `network_mode: service:` configuration. This setup guarantees that the Hub's communication channels are only accessible through the Tailscale network, providing an extra layer of security and privacy. diff --git a/services/beszel/hub/compose.yaml b/services/beszel-hub/compose.yaml similarity index 100% rename from services/beszel/hub/compose.yaml rename to services/beszel-hub/compose.yaml diff --git a/services/beszel/README.md b/services/beszel/README.md deleted file mode 100644 index 87c7982..0000000 --- a/services/beszel/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Beszel with Tailscale Sidecar Configuration - -This Docker Compose configuration integrates [Beszel](https://github.com/henrygd/beszel) with Tailscale in a sidecar setup to enhance secure communication over a private Tailscale network. By utilizing Tailscale, this configuration ensures that all communication handled by Beszel remains secure and private within your Tailscale network. Thanks to @[henrygd](https://github.com/henrygd) for the tool development. - -## Beszel - -[Beszel](https://github.com/henrygd/beszel) is a lightweight, open-source communication tool designed for secure messaging and real-time collaboration. It provides an encrypted and efficient way to exchange messages and share information within teams or between devices. This configuration leverages Beszel in conjunction with Tailscale to ensure that all messages are securely transmitted over a private, encrypted network. - -### Hub - -The [Hub](hub) is the core component of Beszel, responsible for routing messages between agents and managing the overall communication flow. In this configuration, the Beszel Hub runs in its own Docker service and is secured by the Tailscale sidecar, ensuring that all traffic to and from the Hub is encrypted and restricted to your Tailscale network. - -### Agent - -The [Agent](agent) is the client-side component that connects to the Hub to send and receive messages. Multiple agents can connect to a single Hub, enabling secure communication across different devices. The Agent also benefits from the Tailscale sidecar, ensuring that its communication with the Hub is conducted over a secure, private network. - -## Configuration Overview - -In this setup, the `tailscale-beszel` service runs Tailscale, which manages secure networking for the Beszel service. The `beszel` service connects to the Tailscale network stack using Docker's `network_mode: service:` configuration. This setup guarantees that Beszel's communication channels are only accessible through the Tailscale network, providing an extra layer of security and privacy.