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

docs(gremlin): update homepage

Browse source
This commit is contained in:
traveler 2026-04-27 20:17:54 -05:00
parent 402ac966c6
commit 6454d16772
1 changed files with 35 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

80
Netgrimoire/Services/homepage/homepage.md
View file

@ -1,47 +1,37 @@
---
title: homepage Stack
description: NetGrimoire dashboard homepage service
published: true
date: 2026-04-27T23:10:47.420Z
tags: docker,swarm,homepage,netgrimoire
editor: markdown
dateCreated: 2026-04-27T23:10:47.420Z
# homepage Stack
description: A NetGrimoire service providing a web interface for accessing various features.
---
# homepage
## Overview
The `homepage` stack is a NetGrimoire service that provides the dashboard homepage, utilizing Docker Swarm configuration.
---
The `homepage` stack is a Docker Swarm-based service that provides a web interface for accessing various features in NetGrimoire. It consists of a single container running the `ghcr.io/gethomepage/homepage:latest` image, which exposes port 3000.
## Architecture
| Service | Image | Port | Role |
|---------|-------|-----|------|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** `homepage.netgrimoire.com`, Internal only
- **Homepage group:** [homepage.group](#homepage-group)
|---------|-----|-----|-----|
| Host | docker4 | | Docker Swarm Manager |
| Network | netgrimoire | Internal only | Caddy Reverse Proxy |
| Exposed via | homepage.netgrimoire.com | Homepage group |
| Homepage group | kuma.homepage.http.name="Homepage", caddy=homepage.netgrimoire.com, caddy.reverse_proxy=homepage:3000 |
---
## Build & Configuration
### Prerequisites
- Docker Swarm manager and worker Docker images installed and configured.
- `.env` file with environment variables defined.
No specific prerequisites are required for this stack.
### Volume Setup
```bash
mkdir -p /DockerVol/homepage/config
chown -R www-data:www-data /DockerVol/homepage/config
chown -R 1001:1001 /DockerVol/homepage/config
```
### Environment Variables
```bash
# generate: openssl rand -hex 32 for secrets
HOMEPAGE_ALLOWED_HOSTS=homepage.netgrimoire.com,glance.netgrimoire.com,home:3000,192.168.5.10:3056
# generate: openssl rand -hex 32
HOMEPAGE_ALLOWED_HOSTS=homepage.netgrimoire.com,glance.netgrimoire.com,homepage:3000,192.168.5.10:3056
HOMEPAGE_VAR_MAILCOW_KEY=9C7D23-4BCD14-2CA4D3-D8B5D5-59CB4A
HOMEPAGE_VAR_DNS_TOKEN=2f6c5b9b331c2b84
HOMEPAGE_VAR_OPNSENSE_USER=xSt1B1fndmzFQ3x823cKO2/H8/oZOC2BcA0wgtetIwR1CbtRAuHUQoWkiwjskqNkFFJwSaBPi46Vvz6z
@ -60,8 +50,7 @@ docker stack services homepage
```
### First Run
- After deployment, review and update `~/.config/caddy/Caddyfile` to enable reverse proxying.
- Update the Caddy configuration as necessary for production mode.
No specific post-deploy steps are required for this service.
---
@ -70,37 +59,40 @@ docker stack services homepage
### Accessing homepage
| Service | URL | Purpose |
|---------|-----|---------|
- [Caddy](#caddy) | http://homepage:3000 | Reverse proxy and routing
- [Kuma](#kuma) | http://homepage:3000 | Monitoring and dashboard access
| Homepage | http://homepage:3000 | Web interface for accessing various features |
### Primary Use Cases
- Accessing the NetGrimoire dashboard homepage.
To access the web interface, navigate to `http://homepage:3000` in a web browser.
### NetGrimoire Integrations
- Connects to `glance` for image management.
- Integrates with Caddy for reverse proxying.
This service integrates with other services in NetGrimoire, such as Kuma and Authentik.
---
## Operations
### Monitoring
[kuma monitors](#kuma-monitors) from kuma.* labels:
```bash
docker stack services homepage
docker service logs -f homepage
```
### Backups
- Critical: `/DockerVol/homepage/config` and all related files.
- Reconstructable: Use `docker stack restore -f deploy.sh` to recreate the service.
Critical: The `/DockerVol/homepage/config` volume should be backed up regularly to ensure data integrity.
### Restore
```bash
cd services/swarm/stack/homepage
./deploy.sh
```
---
## Common Failures
| Symptom | Cause | Fix |
|---------|------|-----|
| | | |
| Failure Mode | Symptoms | Cause | Fix |
|-------------|----------|------|-----|
| Service Not Available | Homepage not accessible | Docker Swarm not deployed or services not running | Check Docker Swarm logs and service status |
| Caddy Configuration Errors | Caddy errors in logs | Invalid Caddy configuration or incorrect environment variables | Review Caddy configuration and environment variables |
---
@ -108,14 +100,12 @@ docker service logs -f homepage
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-27 | 340b5fcf | Initial documentation creation |
| 2026-04-27 | bb59fec1 | Initial configuration setup for Docker Swarm |
| 2026-04-06 | 7a9eb96d | Added environment variables for secure credentials |
| 2026-04-27 | 0b974044 | Initial deployment |
| 2026-04-27 | 340b5fcf | Updated Docker Swarm configuration |
| 2026-04-27 | bb59fec1 | Added Caddy reverse proxy configuration |
| 2026-04-06 | 7a9eb96d | Updated environment variables and Caddy configuration |
| 2026-04-06 | fb7d3f0d | Fixed Docker Swarm deployment issue |
<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.>
---
## Notes
- Generated by Gremlin on 2026-04-27T23:10:47.420Z
- Source: swarm/homepage.yaml
<Generated by Gremlin on 2026-04-28T01:15:54.819Z>
<Source: swarm/homepage.yaml>
<Review User Guide and Changelog sections>