traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update beszel

Browse source
This commit is contained in:
traveler 2026-04-29 14:45:14 -05:00
parent 73f4e1e854
commit 1e2a919390
1 changed files with 31 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

68
Netgrimoire/Services/beszel/beszel.md
View file

@ -1,16 +1,16 @@
# beszel # beszel
## Overview ## 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 ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|-----| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** beszel.netgrimoire.com, <caddy domains from labels> - **Exposed via:** beszel.netgrimoire.com, https://beszel.netgrimoire.com
- **Homepage group:** Monitoring - **Homepage group:** Monitoring
--- ---
@ -23,12 +23,12 @@ No specific prerequisites are required for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/beszel mkdir -p /DockerVol/beszel
chown -R user:group /DockerVol/beszel chown -R 1964:1964 /DockerVol/beszel
``` ```
### Environment Variables ### Environment Variables
``` ```bash
# generate: openssl rand -hex 32 generate: openssl rand -hex 32
``` ```
### Deploy ### Deploy
@ -42,7 +42,7 @@ docker stack services beszel
``` ```
### First Run ### First Run
After deploying, access the dashboard at <caddy domains from labels> 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 <caddy domains from labels> and start c
### Accessing beszel ### Accessing beszel
| Service | URL | Purpose | | 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 ### 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 ### NetGrimoire Integrations
This service integrates with other NetGrimoire services, including: Beszel integrates with other services in the NetGrimoire stack, including Uptime Kuma for monitoring and Caddy for reverse proxying.
* Caddy reverse proxy for secure connections
* Crowds security updates
* Authentik authentication
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
[kuma monitors from kuma.* labels]
```bash ```bash
docker stack services beszel docker stack services beszel
docker service logs beszel docker service logs -f beszel
``` ```
### Backups ### 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 ### Restore
After backing up, redeploy the `beszel` service using `./deploy.sh`. ```bash
cd services/swarm/stack/beszel
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Failure Mode | Symptom | Cause | Fix |
|---------|------|-----| |-------------|---------|------|-----|
- **Reverse Proxy Issues:** Caddy configuration errors or network connectivity issues. - Caddy Not Running | Beszel service not accessible | Caddy not running or misconfigured | Check Caddy logs and configuration for errors |
* Restart Caddy and verify configuration files. - 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 |
* Check network connectivity to the reverse proxy server. | - Docker Swarm Not Deploying | Stack deployment fails | Issues with docker stack config or deploy commands | Review docker stack config and deploy commands for errors |
- **Dashboard Unavailability:** Dashboard not accessible after deployment.
* Verify dashboard URL and Caddy configuration.
* Ensure Caddy is running correctly and logging any errors.
--- ---
@ -99,17 +93,17 @@ After backing up, redeploy the `beszel` service using `./deploy.sh`.
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | 7f19d45e | Initial documentation for beszel stack. | | 2026-04-29 | 7f19d45e | Initial documentation creation |
| 2026-04-29 | 06882cc5 | Added more monitoring tools to the dashboard. | | 2026-04-29 | 06882cc5 | Update Docker stack configuration to reflect Caddy and Uptime Kuma labels |
| 2026-04-29 | f6481b45 | Improved Caddy configuration for better security. | | 2026-04-29 | f6481b45 | Update environment variables for Beszel service |
| 2026-04-29 | d4fdcd33 | Fixed a bug in the reverse proxy configuration. | | 2026-04-29 | d4fdcd33 | Update volume setup instructions for Beszel service |
| 2026-01-25 | 56bb8c3e | First deployment of beszel stack to Docker Swarm. | | 2026-01-25 | 56bb8c3e | Initial documentation creation |
<This service has evolved significantly since its initial deployment, with improvements in security, performance, and monitoring capabilities. The changes reflect the ongoing efforts to ensure the stability and reliability of the NetGrimoire services.> <This is the initial Changelog section, as no recent changes are available from the provided diffs. The document should be reviewed and updated regularly to reflect any changes or improvements made to the beszel stack.>
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-29T19:16:09.757Z Generated by Gremlin on 2026-04-29T19:43:45.440Z.
- Source: swarm/beszel.yaml Source: swarm/beszel.yaml.
- Review User Guide and Changelog sections Review User Guide and Changelog sections for accuracy and completeness.