Skip to content

Commit bf2d433

Browse files
authored
Refactor Beszel service structure: separate Hub and Agent configurations, update README, and remove deprecated files (#206)
1 parent ac074c8 commit bf2d433

File tree

8 files changed

+24
-20
lines changed

8 files changed

+24
-20
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,8 @@ If you would like to add your own config, you can use the [service-template](tem
142142

143143
| 📈 Service | 📝 Description | 🔗 Link |
144144
| ----------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------- |
145-
| 📉 **Beszel** | A lightweight server monitoring hub with historical data, Docker stats, and alerts. | [Details](services/beszel) |
145+
| 📉 **Beszel Hub** | The Beszel Hub provides historical monitoring data, Docker stats, and alerts. | [Details](services/beszel-hub) |
146+
| 🛰️ **Beszel Agent** | The Beszel Agent collects stats and reports them back to the Hub. | [Details](services/beszel-agent) |
146147
| 🔎 **Portracker** | A simple, self-hosted port monitoring and tracking tool for auditing open ports. | [Details](services/portracker) |
147148
| 🚀 **Speedtest Tracker** | A self-hosted tool to monitor and log internet speed tests with detailed visualizations. | [Details](services/speedtest-tracker) |
148149
| 📊 **Uptime Kuma** | A self-hosted monitoring tool like "Uptime Robot". | [Details](services/uptime-kuma) |

services/beszel-agent/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Beszel Agent with Tailscale Sidecar Configuration
2+
3+
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.
4+
5+
## Beszel Agent
6+
7+
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.
8+
9+
## Configuration Overview
10+
11+
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.

services/beszel-hub/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Beszel Hub with Tailscale Sidecar Configuration
2+
3+
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.
4+
5+
## Beszel Hub
6+
7+
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.
8+
9+
## Configuration Overview
10+
11+
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.

services/beszel/README.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)