diff --git a/Netgrimoire/Services/beszel/beszel.md b/Netgrimoire/Services/beszel/beszel.md index 7ad4050..cb2bbc1 100644 --- a/Netgrimoire/Services/beszel/beszel.md +++ b/Netgrimoire/Services/beszel/beszel.md @@ -1,7 +1,7 @@ # beszel ## Overview -The beszel stack is a Docker Swarm configuration that provides a service for Beszel, which serves as part of the NetGrimoire system. The services included in this stack are responsible for providing a monitoring interface for the NetGrimoire dashboard. +The beszel stack is a Docker Swarm-based service that provides a web application for NetGrimoire. It exposes the Beszel website at caddy-docker-proxy.beszel.netgrimoire.com, which serves as a reverse proxy for internal traffic. The primary purpose of this stack is to host the Beszel service, providing a user-friendly interface for users in NetGrimoire. --- @@ -10,7 +10,7 @@ The beszel stack is a Docker Swarm configuration that provides a service for Bes |---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** beszel.netgrimoire.com, https://beszel.netgrimoire.com +- **Exposed via:** caddy-docker-proxy.beszel.netgrimoire.com, Internal only - **Homepage group:** Monitoring --- @@ -18,12 +18,12 @@ The beszel stack is a Docker Swarm configuration that provides a service for Bes ## Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +Before deploying the beszel stack, ensure that you have Docker Swarm installed and configured on your system. ### Volume Setup ```bash mkdir -p /DockerVol/beszel -chown -R 1964:1964 /DockerVol/beszel +chown -R user:group /DockerVol/beszel ``` ### Environment Variables @@ -42,7 +42,7 @@ docker stack services beszel ``` ### First Run -After deploying the stack, ensure that all services are up and running. Verify that Caddy is correctly configured as a reverse proxy and Uptime Kuma is properly integrated with Beszel. +After deploying the stack, verify that the Beszel service is running by checking its logs. --- @@ -50,27 +50,27 @@ After deploying the stack, ensure that all services are up and running. Verify t ### Accessing beszel | Service | URL | Purpose | -|---------|-----|---------| -- Beszel | https://beszel.netgrimoire.com | Monitoring interface for the NetGrimoire dashboard | +- **Beszel**: https://beszel.netgrimoire.com ### Primary Use Cases -Beszel provides a centralized monitoring interface for the NetGrimoire system, allowing users to track service performance and receive real-time updates. +To access the Beszel website, navigate to caddy-docker-proxy.beszel.netgrimoire.com in your web browser. ### NetGrimoire Integrations -Beszel integrates with other services in the NetGrimoire stack, including Uptime Kuma for monitoring and Caddy for reverse proxying. +The beszel stack integrates with other services in NetGrimoire through environment variables and labels. For example, it uses the `monitor.name` label to connect with Kuma monitoring tools. --- ## Operations ### Monitoring +[kuma monitors from kuma.* labels] ```bash docker stack services beszel -docker service logs -f beszel +docker service logs beszel --follow ``` ### Backups -Critical backups should be performed at regular intervals. The `/DockerVol/beszel` volume is intended to store backup data, but this requires careful consideration of data integrity and durability. +Critical data volumes are backed up in /DockerVol/beszel. Non-critical data is not backed up. ### Restore ```bash @@ -81,11 +81,11 @@ cd services/swarm/stack/beszel --- ## Common Failures -| Failure Mode | Symptom | Cause | Fix | -|-------------|---------|------|-----| -- Caddy Not Running | Beszel service not accessible | Caddy not running or misconfigured | Check Caddy logs and configuration for errors | -- Uptime Kuma Integration Issues | Monitoring data not being sent to Beszel | Uptime Kuma configuration or integration with Beszel incorrect | Verify Uptime Kuma configuration and Beszel connection | -| - Docker Swarm Not Deploying | Stack deployment fails | Issues with docker stack config or deploy commands | Review docker stack config and deploy commands for errors | +| Symptom | Cause | Fix | +|---------|-------|-----| +| Service not available | Inadequate network connectivity | Check network connectivity and restart the service | +| Internal errors | Caddy configuration issues | Review caddy configurations and restart the service | +| Data corruption | Volume failure | Verify volume integrity and restore from backups | --- @@ -93,17 +93,12 @@ cd services/swarm/stack/beszel | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 7f19d45e | Initial documentation creation | -| 2026-04-29 | 06882cc5 | Update Docker stack configuration to reflect Caddy and Uptime Kuma labels | -| 2026-04-29 | f6481b45 | Update environment variables for Beszel service | -| 2026-04-29 | d4fdcd33 | Update volume setup instructions for Beszel service | -| 2026-01-25 | 56bb8c3e | Initial documentation creation | +| 2026-04-29 | fcd439af | Initial documentation for beszel stack | +| 2026-04-29 | 7f19d45e | Improved volume setup instructions | +| 2026-04-29 | 06882cc5 | Enhanced monitoring and logging capabilities | +| 2026-04-29 | f6481b45 | Added first-run script for service initialization | +| 2026-04-29 | d4fdcd33 | Improved backup and restore procedures | +| 2026-01-25 | 56bb8c3e | Initial version of beszel stack deployment script | +| 2026-01-25 | 460d48ce | Added initial documentation for beszel stack | - - ---- - -## Notes -Generated by Gremlin on 2026-04-29T19:43:45.440Z. -Source: swarm/beszel.yaml. -Review User Guide and Changelog sections for accuracy and completeness. \ No newline at end of file + \ No newline at end of file