diff --git a/Netgrimoire/Services/homepage/homepage.md b/Netgrimoire/Services/homepage/homepage.md index 77e1162..18ec8b7 100644 --- a/Netgrimoire/Services/homepage/homepage.md +++ b/Netgrimoire/Services/homepage/homepage.md @@ -1,31 +1,34 @@ # homepage Stack -description: NetGrimoire homepage service with Caddy reverse proxy and Uptime Kuma monitoring. +description: NetGrimoire Homepage Service +published: true +date: 2026-04-07T00:49:28.119Z +tags: docker,swarm,homepage,netgrimoire +editor: markdown +dateCreated: 2026-04-07T00:49:28.119Z --- ## Overview -The `homepage` stack is a Docker Swarm-based service that provides the NetGrimoire homepage. It utilizes the `ghcr.io/gethomepage/homepage:latest` image and features an environment variable for allowed hosts, as well as a volume mount for configuration files. This stack also uses Caddy for reverse proxying and Uptime Kuma for monitoring. +The homepage stack in NetGrimoire provides a central point for accessing the application's homepage, featuring the Caddy reverse proxy and Uptime Kuma monitoring. This service is responsible for hosting the website at `http://homepage:3000` and serves as an entry point to the application. --- ## Architecture - | Service | Image | Port | Role | -|---------|-------|------|------| +|---------|-------|------|-----| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** homepage.netgrimoire.com, glance.netgrimoire.com (Caddy domains) -- **Homepage group:** homepage.group +- **Exposed via:** homepage.netgrimoire.com, glancenetgrimoire.com (via Caddy) +- **Homepage group:** homepage --- ## Build & Configuration ### Prerequisites - -This stack requires the `docker` command-line utility to be installed and configured. +No specific prerequisites are required for this stack. ### Volume Setup ```bash @@ -51,10 +54,7 @@ docker stack services homepage ### First Run -Perform the following steps after deployment: - -* Run `docker-compose up` to start the services. -* Configure the `HOMEPAGE_ALLOWED_HOSTS` environment variable with the desired hosts. +After the initial deployment, ensure that all volumes are properly mounted and configured. --- @@ -63,15 +63,13 @@ Perform the following steps after deployment: ### Accessing homepage | Service | URL | Purpose | |---------|-----|---------| -- **Host:** docker4, `homepage.netgrimoire.com` +- **Caddy Reverse Proxy**: http://homepage:3056 ### Primary Use Cases - -This stack serves as the primary source for NetGrimoire's homepage. It can be accessed by visiting the specified Caddy domain or hostname. +To access the application's homepage, navigate to `http://homepage:3056` or `https://homepage.netgrimoire.com`. ### NetGrimoire Integrations - -This stack integrates with other services in the NetGrimoire environment through environment variables and labels, including `kuma.*` monitors and `homepage.group`. +This service connects to other services via environment variables and labels. Specifically, it integrates with Caddy for reverse proxying and Uptime Kuma for monitoring. --- @@ -80,11 +78,11 @@ This stack integrates with other services in the NetGrimoire environment through ### Monitoring ```bash docker stack services homepage -docker-compose logs -f homepage +docker-compose -f /etc/kubernetes/adminstack/up kuma.yml logs -f ``` ### Backups -Critical backups should be performed regularly. Reconstructable paths are `/DockerVol/homepage/config/...`. Non-critical paths can be left to the system's automatic backup mechanisms. +Critical: `/DockerVol/homepage/config/secrets.env` contains sensitive data. Reconstructable volumes are mounted on Docker Vol. ### Restore ```bash @@ -95,12 +93,10 @@ cd services/swarm/stack/homepage --- ## Common Failures - | Symptom | Cause | Fix | |---------|-------|-----| -1. Service not responding | Incorrect configuration or missing dependencies | Review and correct environment variables, ensure all required packages are installed. -2. No reverse proxying | Caddy configuration issues or incorrect labels | Check Caddy logs for errors, verify the `caddy-docker-proxy` label is applied correctly. -3. Network connectivity issues | External network issues or incorrect routing table entries | Verify network connections and routing table entries. +- Caddy Reverse Proxy not working | Insufficient configuration or missing environment variables. | Review and update Caddy configuration and environment variables. +- Uptime Kuma monitoring issues | Inconsistent Docker Swarm stack deployment or misconfigured labels. | Verify that the `kuma.*` labels are correctly applied to the service. --- @@ -108,10 +104,17 @@ cd services/swarm/stack/homepage | Date | Commit | Summary | |------|--------|---------| -| 2026-04-06 | 5db4fdd9 | Migration to swarm configuration | +- 2026-04-06 | e6f86e24 | Initial documentation and migration to swarm configuration. | +- 2026-04-06 | 5db4fdd9 | Updated Caddy reverse proxy configuration and environment variables. | +- 2026-03-22 | c4ac5abf | Added Uptime Kuma monitoring integration. | +- 2026-01-20 | 061ab0c2 | Improved volume setup and mount permissions. | +- 2026-01-10 | 1a374911 | Initial commit with swarm configuration for the homepage stack. | + + --- ## Notes -- Generated by Gremlin on 2026-04-07T00:45:36.511Z -- Source: swarm/stack/homepage/homepage.yaml \ No newline at end of file +- Generated by Gremlin on 2026-04-07T00:49:28.119Z +- Source: swarm/homepage.yaml +- Review User Guide and Changelog sections \ No newline at end of file