diff --git a/Netgrimoire/Services/homepage/homepage.md b/Netgrimoire/Services/homepage/homepage.md index d5e9ca0..2bc59eb 100644 --- a/Netgrimoire/Services/homepage/homepage.md +++ b/Netgrimoire/Services/homepage/homepage.md @@ -1,51 +1,51 @@ -# homepage Stack - -description: NetGrimoire Homepage Service - --- title: homepage Stack -description: NetGrimoire Homepage Service description +description: NetGrimoire dashboard homepage service published: true -date: 2026-04-27T21:53:42.896Z +date: 2026-04-27T23:10:47.420Z tags: docker,swarm,homepage,netgrimoire editor: markdown -dateCreated: 2026-04-27T21:53:42.896Z +dateCreated: 2026-04-27T23:10:47.420Z --- + # 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. +The `homepage` stack is a NetGrimoire service that provides the dashboard homepage, utilizing Docker Swarm configuration. --- ## Architecture - | Service | Image | Port | Role | -|---------|-------|------|------| -| Host | docker4 | | | -| Network | netgrimoire | Internal only, homepage.netgrimoire.com | Homepage Group | +|---------|-------|-----|------| +- **Host:** docker4 +- **Network:** netgrimoire +- **Exposed via:** `homepage.netgrimoire.com`, Internal only +- **Homepage group:** [homepage.group](#homepage-group) --- ## Build & Configuration ### Prerequisites -No prerequisites are specified for this stack. +- Docker Swarm manager and worker Docker images installed and configured. +- `.env` file with environment variables defined. ### Volume Setup ```bash mkdir -p /DockerVol/homepage/config -chown -R nobody:nobody /DockerVol/homepage/config +chown -R www-data:www-data /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 \ +# generate: openssl rand -hex 32 for secrets +HOMEPAGE_ALLOWED_HOSTS=homepage.netgrimoire.com,glance.netgrimoire.com,home: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 +HOMEPAGE_VAR_OPNSENSE_PASS=8OBBLQWxz6Wdz/NOFkhmg/0kzAIf2gXCFpFOLbcLmZ83lRyBhk4Ev593omDLYm/Av+AC+mDPlA8Wzkfz HOMEPAGE_VAR_IMMICH_KEY=yawqFGqMOQnGIXLmYr2daygAFFIHMaTnqOWNwZhm8SU ``` @@ -60,7 +60,8 @@ docker stack services homepage ``` ### First Run -Upon initial deployment, the `homepage` service should be accessible at . +- After deployment, review and update `~/.config/caddy/Caddyfile` to enable reverse proxying. +- Update the Caddy configuration as necessary for production mode. --- @@ -69,43 +70,37 @@ Upon initial deployment, the `homepage` service should be accessible at . +- Accessing the NetGrimoire dashboard homepage. ### NetGrimoire Integrations -The `homepage` service integrates with other NetGrimoire services through environment variables and labels. +- Connects to `glance` for image management. +- Integrates with Caddy for reverse proxying. --- ## Operations ### Monitoring -For monitoring purposes, use `docker stack services homepage`. - +[kuma monitors](#kuma-monitors) from kuma.* labels: ```bash docker stack services homepage +docker service logs -f 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 -``` +- Critical: `/DockerVol/homepage/config` and all related files. +- Reconstructable: Use `docker stack restore -f deploy.sh` to recreate the service. --- ## 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. | +|---------|------|-----| +| | | | --- @@ -113,11 +108,14 @@ cd services/swarm/stack/homepage | Date | Commit | Summary | |------|--------|---------| -| 2026-04-27 | bb59fec1 | Initial documentation for homepage stack in NetGrimoire. | -| 2026-04-06 | 7a9eb96d | Migrated to Docker Swarm configuration. | +| 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 | + + --- ## Notes -- Generated by Gremlin on 2026-04-27T21:53:42.896Z +- Generated by Gremlin on 2026-04-27T23:10:47.420Z - Source: swarm/homepage.yaml \ No newline at end of file