diff --git a/Netgrimoire/Services/beszel/beszel.md b/Netgrimoire/Services/beszel/beszel.md index c303a3a..2571da1 100644 --- a/Netgrimoire/Services/beszel/beszel.md +++ b/Netgrimoire/Services/beszel/beszel.md @@ -1,36 +1,34 @@ # beszel ## Overview -The beszel stack is a Docker Swarm service that provides a Beszel instance in NetGrimoire, serving as the primary Beszel service. It exposes the Beszel application at port 8098. +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. --- ## Architecture | Service | Image | Port | Role | -|---------|-------|-----|------| -- **beszel**: henrygd/beszel | - | 8090 | Beszel Application | -| | - | 8098 | Exposed via Caddy | - +|---------|-------|------|-----| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** beszel.netgrimoire.com +- **Exposed via:** beszel.netgrimoire.com, +- **Homepage group:** Monitoring --- ## Build & Configuration ### Prerequisites -Ensure you have a Docker Swarm manager and worker node, set up with the required labels. +No specific prerequisites are required for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/beszel -chown -R docker:docker /DockerVol/beszel +chown -R user:group /DockerVol/beszel ``` ### Environment Variables -```bash -generate: openssl rand -hex 32 +``` +# generate: openssl rand -hex 32 ``` ### Deploy @@ -44,7 +42,7 @@ docker stack services beszel ``` ### First Run -This is a standard first run process for the new stack, no additional steps are required. +After deploying, access the dashboard at and start configuring the service. --- @@ -52,43 +50,48 @@ This is a standard first run process for the new stack, no additional steps are ### Accessing beszel | Service | URL | Purpose | -|---------|-----|---------| -- **Beszel**: https://beszel.netgrimoire.com +- **Beszel Dashboard:** beszel.netgrimoire.com +- **Monitor Website:** https://beszel.netgrimoire.com ### Primary Use Cases - Beszel is primarily used as a monitoring and logging service in NetGrimoire, serving Beszel data to other services. +Use the beszel stack to monitor and manage NetGrimoire services, such as Uptime Kuma instances. ### NetGrimoire Integrations -This stack integrates with Uptime Kuma for monitoring and Uptime Kuma logs the Beszel application at port 8090. +This service integrates with other NetGrimoire services, including: + +* Caddy reverse proxy for secure connections +* Crowds security updates +* Authentik authentication --- ## Operations ### Monitoring +[kuma monitors from kuma.* labels] ```bash docker stack services beszel -docker service logs -f beszel +docker service logs beszel ``` ### Backups -Critical backup paths require special attention due to sensitive data. The Docker volumes should be backed up regularly, and any potential recovery procedures need to consider the state of these volumes. +Critical data should be stored on the `/DockerVol/beszel` volume. ### Restore -```bash -cd services/swarm/stack/beszel -./deploy.sh -``` +After backing up, redeploy the `beszel` service using `./deploy.sh`. --- ## Common Failures - | Symptom | Cause | Fix | -|---------|-------|-----| -- Beszel is not available | Caddy failed to start | Check caddy logs for errors. -- Logs are missing from Uptime Kuma | Beszel service did not deploy correctly | Run `docker stack services beszel` and inspect the container logs. -- Beszel is not accessible at port 8098 | Docker was not running correctly | Use `docker-compose up -d` to start containers in detached mode. +|---------|------|-----| +- **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. --- @@ -96,19 +99,17 @@ cd services/swarm/stack/beszel | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | f6481b45 | Initial Documentation | -| 2026-04-29 | d4fdcd33 | Minor Adjustments for better readability and clarity. | -| 2026-01-25 | 56bb8c3e | Initial Version of beszel Stack | -| 2026-01-25 | 460d48ce | Minor improvements to the stack documentation | -| 2026-01-10 | 1a374911 | Initial creation of this repository | +| 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. | - - -The beszel Stack has undergone several minor adjustments and improvements since its initial version in January 2026, with further development occurring during April 2026. The stack now provides better documentation for users, improving the overall experience. + --- ## Notes -- Generated by Gremlin on 2026-04-29T19:16:06.652Z +- 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