diff --git a/Netgrimoire/Services/beszel/beszel.md b/Netgrimoire/Services/beszel/beszel.md index 2571da1..7ad4050 100644 --- a/Netgrimoire/Services/beszel/beszel.md +++ b/Netgrimoire/Services/beszel/beszel.md @@ -1,16 +1,16 @@ # beszel ## Overview -The beszel stack is a Docker Swarm-based service that provides a web interface for monitoring and managing various NetGrimoire services. It consists of several components, including a reverse proxy server (Caddy), a dashboard (Homepage), and monitoring tools. +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. --- ## Architecture | Service | Image | Port | Role | -|---------|-------|------|-----| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** beszel.netgrimoire.com, +- **Exposed via:** beszel.netgrimoire.com, https://beszel.netgrimoire.com - **Homepage group:** Monitoring --- @@ -23,12 +23,12 @@ No specific prerequisites are required for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/beszel -chown -R user:group /DockerVol/beszel +chown -R 1964:1964 /DockerVol/beszel ``` ### Environment Variables -``` -# generate: openssl rand -hex 32 +```bash +generate: openssl rand -hex 32 ``` ### Deploy @@ -42,7 +42,7 @@ docker stack services beszel ``` ### First Run -After deploying, access the dashboard at and start configuring the service. +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. --- @@ -50,48 +50,42 @@ After deploying, access the dashboard at and start c ### Accessing beszel | Service | URL | Purpose | -- **Beszel Dashboard:** beszel.netgrimoire.com -- **Monitor Website:** https://beszel.netgrimoire.com +|---------|-----|---------| +- Beszel | https://beszel.netgrimoire.com | Monitoring interface for the NetGrimoire dashboard | ### Primary Use Cases -Use the beszel stack to monitor and manage NetGrimoire services, such as Uptime Kuma instances. +Beszel provides a centralized monitoring interface for the NetGrimoire system, allowing users to track service performance and receive real-time updates. ### NetGrimoire Integrations -This service integrates with other NetGrimoire services, including: - -* Caddy reverse proxy for secure connections -* Crowds security updates -* Authentik authentication +Beszel integrates with other services in the NetGrimoire stack, including Uptime Kuma for monitoring and Caddy for reverse proxying. --- ## Operations ### Monitoring -[kuma monitors from kuma.* labels] ```bash docker stack services beszel -docker service logs beszel +docker service logs -f beszel ``` ### Backups -Critical data should be stored on the `/DockerVol/beszel` volume. +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. ### Restore -After backing up, redeploy the `beszel` service using `./deploy.sh`. +```bash +cd services/swarm/stack/beszel +./deploy.sh +``` --- ## Common Failures -| Symptom | Cause | Fix | -|---------|------|-----| -- **Reverse Proxy Issues:** Caddy configuration errors or network connectivity issues. - * Restart Caddy and verify configuration files. - * Check network connectivity to the reverse proxy server. - -- **Dashboard Unavailability:** Dashboard not accessible after deployment. - * Verify dashboard URL and Caddy configuration. - * Ensure Caddy is running correctly and logging any errors. +| 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 | --- @@ -99,17 +93,17 @@ After backing up, redeploy the `beszel` service using `./deploy.sh`. | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 7f19d45e | Initial documentation for beszel stack. | -| 2026-04-29 | 06882cc5 | Added more monitoring tools to the dashboard. | -| 2026-04-29 | f6481b45 | Improved Caddy configuration for better security. | -| 2026-04-29 | d4fdcd33 | Fixed a bug in the reverse proxy configuration. | -| 2026-01-25 | 56bb8c3e | First deployment of beszel stack to Docker Swarm. | +| 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 | - + --- ## Notes -- Generated by Gremlin on 2026-04-29T19:16:09.757Z -- Source: swarm/beszel.yaml -- Review User Guide and Changelog sections \ No newline at end of file +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