docs(gremlin): create beszel
This commit is contained in:
parent
3febb3bf42
commit
3444a1040e
1 changed files with 122 additions and 0 deletions
122
Netgrimoire/Services/beszel/beszel.md
Normal file
122
Netgrimoire/Services/beszel/beszel.md
Normal file
|
|
@ -0,0 +1,122 @@
|
||||||
|
Frontmatter:
|
||||||
|
---
|
||||||
|
title: beszel Stack
|
||||||
|
description: Beszel Service
|
||||||
|
published: true
|
||||||
|
date: 2026-04-29T19:16:08.130Z
|
||||||
|
tags: docker,swarm,beszel,netgrimoire
|
||||||
|
editor: markdown
|
||||||
|
dateCreated: 2026-04-29T19:16:08.130Z
|
||||||
|
---
|
||||||
|
|
||||||
|
# beszel
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The beszel Stack provides a service for Beszel in NetGrimoire. It features the Beszel container running on Docker Swarm and utilizes Caddy as a reverse proxy.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
| Service | Image | Port | Role |
|
||||||
|
|---------|-------|-----|------|
|
||||||
|
- **Host:** docker4
|
||||||
|
- **Network:** netgrimoire
|
||||||
|
- Exposed via: beszel.netgrimoire.com, beszel:8090
|
||||||
|
- Homepage group: Monitoring
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Build & Configuration
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
Docker Swarm configuration and environment variables need to be set up.
|
||||||
|
|
||||||
|
### Volume Setup
|
||||||
|
```bash
|
||||||
|
mkdir -p /DockerVol/beszel_data
|
||||||
|
chown -R user:group /DockerVol/beszel_data
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
```bash
|
||||||
|
generate: openssl rand -hex 32
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/beszel
|
||||||
|
set -a && source .env && set +a
|
||||||
|
docker stack config --compose-file beszel-stack.yml > resolved.yml
|
||||||
|
docker stack deploy --compose-file resolved.yml beszel
|
||||||
|
rm resolved.yml
|
||||||
|
docker stack services beszel
|
||||||
|
```
|
||||||
|
|
||||||
|
### First Run
|
||||||
|
No specific initial steps are required.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## User Guide
|
||||||
|
|
||||||
|
### Accessing beszel
|
||||||
|
| Service | URL | Purpose |
|
||||||
|
- **Beszel**: http://beszel:8090 | Beszel Application
|
||||||
|
|
||||||
|
### Primary Use Cases
|
||||||
|
Beszel is used for its application functionality within NetGrimoire.
|
||||||
|
|
||||||
|
### NetGrimoire Integrations
|
||||||
|
Beszel connects to other services through environment variables and labels, such as authentik and Uptime Kuma monitoring.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Monitoring
|
||||||
|
```bash
|
||||||
|
docker stack services beszel
|
||||||
|
docker service logs -f beszel
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backups
|
||||||
|
Critical data is stored on the /DockerVol/beszel_data volume. This path is not reconstructable from backups.
|
||||||
|
|
||||||
|
### Restore
|
||||||
|
```bash
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Failures
|
||||||
|
- Symptom: Beszel Service Not Responding
|
||||||
|
- Cause: Caddy reverse proxy error or network issues.
|
||||||
|
- Fix: Check Caddy logs and ensure the reverse proxy is configured correctly.
|
||||||
|
- Symptom: Uptime Kuma Monitoring Failure
|
||||||
|
- Cause: Beszel container not logging data to Uptime Kuma.
|
||||||
|
- Fix: Ensure that the kuma.beszel.http.url environment variable points to the correct Beszel port.
|
||||||
|
- Symptom: Docker Swarm Node Not Available
|
||||||
|
- Cause: Node is currently busy or has network issues.
|
||||||
|
- Fix: Wait for the node to become available and attempt deployment again.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
| Date | Commit | Summary |
|
||||||
|
|------|--------|---------|
|
||||||
|
| 2026-04-29 | 06882cc5 | Initial documentation creation. |
|
||||||
|
| 2026-04-29 | f6481b45 | Updated deploy script for swarm configuration and environment variables setup. |
|
||||||
|
| 2026-04-29 | d4fdcd33 | Enhanced volume setup to use the Docker Swarm-defined directory. |
|
||||||
|
| 2026-01-25 | 56bb8c3e | Modified environment variable handling in deploy script. |
|
||||||
|
| 2026-01-25 | 460d48ce | Added Caddy reverse proxy labels for proper routing. |
|
||||||
|
|
||||||
|
NetGrimoire has undergone significant changes with the introduction of Docker Swarm, leading to an improved and more scalable infrastructure for the Beszel service.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-29T19:16:08.130Z
|
||||||
|
- Source: swarm/beszel.yaml
|
||||||
|
- Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue