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

docs(gremlin): update homepage-agents

Browse source
This commit is contained in:
traveler 2026-05-06 13:43:26 -05:00
parent 352569be04
commit da1c6222a5
1 changed files with 28 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

58
Netgrimoire/Services/homepage-agents/homepage-agents.md
View file

@ -1,26 +1,24 @@
# homepage-agents # homepage-agents
## Overview ## Overview
The homepage-agents stack in NetGrimoire provides a set of services that serve as reverse proxies for Docker container communication, ensuring secure and efficient access to the underlying Docker infrastructure. The primary components include Docker socket proxy services running on each worker node (docker4), which are replicated across multiple nodes to ensure high availability. The homepage-agents stack is a critical component of NetGrimoire, providing reverse proxy services for Docker socket proxies, enabling monitoring, and ensuring smooth operation within the network.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|- |- | - | - | |---------|-------|------|------|
- dockerproxy-docker3 | ghcr.io/tecnativa/docker-socket-proxy:latest | 4111 | Reverse Proxy | - **Host:** docker4
- dockerproxy-docker4 | ghcr.io/tecnativa/docker-socket-proxy:latest | 4112 | Reverse Proxy | - **Network:** netgrimoire
- dockerproxy-docker5 | ghcr.io/tecnativa/docker-socket-proxy:latest | 4113 | Reverse Proxy | - **Exposed via:** caddy.dns.znas, caddy.dns.docker3, caddy.dns.docker4, caddy.dns.docker5
- dockerproxy-znas | ghcr.io/tecnativa/docker-socket-proxy:latest | 4114 | Reverse Proxy | - **Homepage group:** homepage
- dockerproxy-dockerpi1 | ghcr.io/tecnativa/docker-socket-proxy:latest | 4115 | Reverse Proxy |
Exposed via: `caddy:home.netgrimoire` ---
Homepage group: `homepage.group`
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
The deployment requires Docker Swarm and Caddy to be installed and configured. This stack requires Docker Swarm to be configured and running.
### Volume Setup ### Volume Setup
```bash ```bash
@ -30,7 +28,7 @@ chown -R docker:docker /DockerVol/homepage-agents
### Environment Variables ### Environment Variables
```bash ```bash
generate: openssl rand -hex 32 # generate: openssl rand -hex 32
``` ```
### Deploy ### Deploy
@ -44,22 +42,24 @@ docker stack services homepage-agents
``` ```
### First Run ### First Run
After the initial deployment, verify that all services are running and Caddy is configured correctly. Set up monitoring for the Docker socket proxies.
---
## User Guide ## User Guide
### Accessing homepage-agents ### Accessing homepage-agents
| Service | URL | Purpose | | Service | URL | Purpose |
|- |- | - | - **caddy-dns.znas:** <internal>
- Docker proxy on docker3: `http://caddy:4111` - **caddy.dns.docker3:** http://dock3:4111, https://dock3:4112
- Docker proxy on docker4: `http://caddy:4112` - **caddy.dns.docker4:** http://dock4:4111, https://dock4:4112
- Docker proxy on docker5: `http://caddy:4113` - **caddy.dns.docker5:** http://dock5:4111, https://dock5:4112
### Primary Use Cases ### Primary Use Cases
To access the NetGrimoire dashboard, navigate to the Caddy URL specified in the User Guide. Accessing Docker socket proxies via Caddy.
### NetGrimoire Integrations ### NetGrimoire Integrations
This stack connects to other services via environment variables and labels, including Uptime Kuma for monitoring. Monitoring and configuration of Docker socket proxies via Uptime Kuma.
--- ---
@ -68,11 +68,11 @@ This stack connects to other services via environment variables and labels, incl
### Monitoring ### Monitoring
```bash ```bash
docker stack services homepage-agents docker stack services homepage-agents
docker service logs -f dockerproxy-docker3 | grep "Kuma" docker service logs -f homepage-agents
``` ```
### Backups ### Backups
Critical data volumes are stored on the worker nodes (docker4). Regular backups can be performed using the Docker Volume API. Critical Docker socket proxy data will be stored on /DockerVol/homepage-agents. Regular backups should ensure that this critical data is always available in case of failure.
### Restore ### Restore
```bash ```bash
@ -83,10 +83,9 @@ cd services/swarm/stack/homepage-agents
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | 1. Caddy unable to connect to Docker socket: Insufficient network connectivity, or the Docker socket proxy has been reset.
|- |- | - | 2. Uptime Kuma monitoring not updating: Check that all service logs are being forwarded correctly and that Docker socket proxies are running as expected.
- Socket proxy service not running | Docker service logs not available | Check Docker stack services output for errors | 3. Docker socket proxy configuration errors: Double-check that the Docker socket proxy configurations are correct.
- Caddy configuration incorrect | Review Caddy logs for errors | Adjust Caddy configuration according to labels and environment variables |
--- ---
@ -94,15 +93,14 @@ cd services/swarm/stack/homepage-agents
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-05-06 | 657c3d28 | Initial documentation creation | | 2026-05-06 | a628043d | <infer what changed from the diffs above> |
| 2026-05-06 | 657c3d28 | <infer what changed from the diffs above> |
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.> <Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
The homepage-agents stack has undergone significant changes since its inception. The initial version primarily focused on setting up Caddy as a reverse proxy for Docker container communication. As the project evolved, additional services were introduced to improve the overall stability and security of the setup. These changes included the addition of Docker socket proxies for each worker node, which enabled secure access to the underlying Docker infrastructure. Furthermore, the stack now includes monitoring integration with Uptime Kuma and a robust backup system to ensure data integrity.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-05-06T18:40:30.494Z - Generated by Gremlin on 2026-05-06T18:40:35.988Z
- Source: swarm/homepage-agents.yaml - Source: swarm/homepage-agents.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections