From 63d8ba28ce02e7f881fd5d0ec9beaa725694f1ec Mon Sep 17 00:00:00 2001 From: traveler Date: Mon, 27 Apr 2026 16:55:44 -0500 Subject: [PATCH] docs(gremlin): create homepage --- Netgrimoire/Services/homepage/homepage.md | 123 ++++++++++++++++++++++ 1 file changed, 123 insertions(+) create mode 100644 Netgrimoire/Services/homepage/homepage.md diff --git a/Netgrimoire/Services/homepage/homepage.md b/Netgrimoire/Services/homepage/homepage.md new file mode 100644 index 0000000..d5e9ca0 --- /dev/null +++ b/Netgrimoire/Services/homepage/homepage.md @@ -0,0 +1,123 @@ +# homepage Stack + +description: NetGrimoire Homepage Service + +--- +title: homepage Stack +description: NetGrimoire Homepage Service description +published: true +date: 2026-04-27T21:53:42.896Z +tags: docker,swarm,homepage,netgrimoire +editor: markdown +dateCreated: 2026-04-27T21:53:42.896Z + +--- +# homepage + +## Overview +The `homepage` stack is a Docker Swarm-based service in NetGrimoire, providing a web presence for the platform. It consists of the `gethomepage/homepage:latest` image, running on `znas`, with additional configuration to enable Caddy reverse proxying and Kuma monitoring. + +--- + +## Architecture + +| Service | Image | Port | Role | +|---------|-------|------|------| +| Host | docker4 | | | +| Network | netgrimoire | Internal only, homepage.netgrimoire.com | Homepage Group | + +--- + +## Build & Configuration + +### Prerequisites +No prerequisites are specified for this stack. + +### Volume Setup +```bash +mkdir -p /DockerVol/homepage/config +chown -R nobody:nobody /DockerVol/homepage/config +``` + +### Environment Variables +```bash +HOMEPAGE_ALLOWED_HOSTS=homepage.netgrimoire.com,glance.netgrimoire.com \ +HOMEPAGE_VAR_MAILCOW_KEY=9C7D23-4BCD14-2CA4D3-D8B5D5-59CB4A \ +HOMEPAGE_VAR_DNS_TOKEN=2f6c5b9b331c2b84 \ +HOMEPAGE_VAR_OPNSENSE_USER=xSt1B1fndmzFQ3x823cKO2/H8/oZOC2BcA0wgtetIwR1CbtRAuHUQoWkiwjskqNkFFJwSaBPi46Vvz6z \ +HOMEPAGE_VAR_OPNSENSE_PASS=8OBBLQWxz6Wdz/NOFkhmg/0kzAIf2gXCFpFOLbcLmZ83lRyBhk4Ev593omDLYm/Av+AC+mDPlA8Wzkfz \ +HOMEPAGE_VAR_IMMICH_KEY=yawqFGqMOQnGIXLmYr2daygAFFIHMaTnqOWNwZhm8SU +``` + +### Deploy +```bash +cd services/swarm/stack/homepage +set -a && source .env && set +a +docker stack config --compose-file homepage-stack.yml > resolved.yml +docker stack deploy --compose-file resolved.yml homepage +rm resolved.yml +docker stack services homepage +``` + +### First Run +Upon initial deployment, the `homepage` service should be accessible at . + +--- + +## User Guide + +### Accessing homepage +| Service | URL | Purpose | +|---------|-----|---------| +| Caddy | https://homepage.netgrimoire.com:443 | Reverse Proxy for Homepage | + +### Primary Use Cases +To access the NetGrimoire dashboard, navigate to . + +### NetGrimoire Integrations +The `homepage` service integrates with other NetGrimoire services through environment variables and labels. + +--- + +## Operations + +### Monitoring +For monitoring purposes, use `docker stack services homepage`. + +```bash +docker stack services homepage +``` + +### Backups +Critical data is stored in `/DockerVol/homepage/config`. Regular backups are recommended for production environments. + +### Restore +To restore the `homepage` service from a backup: +```bash +cd services/swarm/stack/homepage +./deploy.sh +``` + +--- + +## Common Failures + +| Symptom | Cause | Fix | +|---------|-------|-----| +| Service not available | Incorrect Caddy configuration | Verify Caddy reverse proxy settings in `homepage-stack.yml` and restart the service. | +| Service still not available | Docker Swarm issues | Check Docker Swarm status and logs for errors, and attempt to re-deploy the stack. | + +--- + +## Changelog + +| Date | Commit | Summary | +|------|--------|---------| +| 2026-04-27 | bb59fec1 | Initial documentation for homepage stack in NetGrimoire. | +| 2026-04-06 | 7a9eb96d | Migrated to Docker Swarm configuration. | + +--- + +## Notes +- Generated by Gremlin on 2026-04-27T21:53:42.896Z +- Source: swarm/homepage.yaml \ No newline at end of file