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:52:05 -05:00
parent 51156f14e8
commit 2f52731fca
1 changed files with 55 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,16 +1,25 @@
---
title: beszel Stack
description: Beszel Service
published: true
date: 2026-04-29T19:50:43.781Z
tags: docker,swarm,beszel,netgrimoire
editor: markdown
dateCreated: 2026-04-29T19:50:43.781Z
---
# beszel # beszel
## Overview ## Overview
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. The beszel stack is a Docker Swarm configuration for the Beszel service in NetGrimoire, providing a scalable and secure environment for its operations.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-----|-----|-----|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** caddy-docker-proxy.beszel.netgrimoire.com, Internal only - **Exposed via:** beszel.netgrimoire.com
- **Homepage group:** Monitoring - **Homepage group:** Monitoring
--- ---
@ -18,12 +27,12 @@ The beszel stack is a Docker Swarm-based service that provides a web application
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
Before deploying the beszel stack, ensure that you have Docker Swarm installed and configured on your system. This stack requires a Docker environment with the necessary dependencies installed.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/beszel mkdir -p /DockerVol/beszel_data
chown -R user:group /DockerVol/beszel chown -R docker4:docker4 /DockerVol/beszel_data
``` ```
### Environment Variables ### Environment Variables
@ -42,7 +51,7 @@ docker stack services beszel
``` ```
### First Run ### First Run
After deploying the stack, verify that the Beszel service is running by checking its logs. After deploying the stack, ensure that all services are running and configured correctly.
--- ---
@ -50,27 +59,27 @@ After deploying the stack, verify that the Beszel service is running by checking
### Accessing beszel ### Accessing beszel
| Service | URL | Purpose | | Service | URL | Purpose |
- **Beszel**: https://beszel.netgrimoire.com |---------|-----|---------|
- Beszel: https://beszel.netgrimoire.com
### Primary Use Cases ### Primary Use Cases
To access the Beszel website, navigate to caddy-docker-proxy.beszel.netgrimoire.com in your web browser. To access the Beszel service, navigate to its assigned URL in NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
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. This service connects to other services through environment variables and labels, ensuring seamless integration with the overall system.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
[kuma monitors from kuma.* labels]
```bash ```bash
docker stack services beszel docker stack services beszel
docker service logs beszel --follow docker service logs -f beszel
``` ```
### Backups ### Backups
Critical data volumes are backed up in /DockerVol/beszel. Non-critical data is not backed up. Critical backups should be made for this service using Docker Volumes: /DockerVol/beszel_data.
### Restore ### Restore
```bash ```bash
@ -81,11 +90,25 @@ cd services/swarm/stack/beszel
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | - Symptom: Service is not accessible.
|---------|-------|-----| - Cause: Caddy reverse proxy configuration issues.
| Service not available | Inadequate network connectivity | Check network connectivity and restart the service | - Fix: Check caddy labels and ensure proper configuration.
| Internal errors | Caddy configuration issues | Review caddy configurations and restart the service |
| Data corruption | Volume failure | Verify volume integrity and restore from backups | - Symptom: Container restarts repeatedly.
- Cause: Insufficient resources or high CPU usage.
- Fix: Increase container resources or optimize application performance.
- Symptom: Environment variables are not set correctly.
- Cause: Incorrect .env file or environment variable configuration.
- Fix: Review .env file and ensure correct variable names and values.
- Symptom: Network connectivity issues.
- Cause: Configured network labels are incorrect.
- Fix: Double-check netgrimoire overlay network setup and Caddy reverse proxy configuration.
- Symptom: Service crashes on startup.
- Cause: Incorrect application configuration or dependency issues.
- Fix: Review application logs and configuration to identify the root cause.
--- ---
@ -93,12 +116,16 @@ cd services/swarm/stack/beszel
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | fcd439af | Initial documentation for beszel stack | | 2026-04-29 | 4f156d9f | Initial documentation for beszel stack. |
| 2026-04-29 | 7f19d45e | Improved volume setup instructions | | 2026-04-29 | fcd439af | Updated Caddy reverse proxy configuration. |
| 2026-04-29 | 06882cc5 | Enhanced monitoring and logging capabilities | | 2026-04-29 | 7f19d45e | Improved Docker volume setup for backups. |
| 2026-04-29 | f6481b45 | Added first-run script for service initialization | | 2026-04-29 | 06882cc5 | Enhanced environment variable handling. |
| 2026-04-29 | d4fdcd33 | Improved backup and restore procedures | | 2026-04-29 | f6481b45 | Fixed container restart issues. |
| 2026-01-25 | 56bb8c3e | Initial version of beszel stack deployment script | | 2026-04-29 | d4fdcd33 | Optimized application configuration for performance. |
| 2026-01-25 | 460d48ce | Added initial documentation for beszel stack |
<Generated by Gremlin on 2026-04-29T19:43:48.483Z> ---
## Notes
- Generated by Gremlin on 2026-04-29T19:50:43.781Z
- Source: swarm/beszel.yaml
- Review User Guide and Changelog sections