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-06 19:50:38 -05:00
parent b01f49ffa7
commit fb5cf0dee4
1 changed files with 29 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,31 +1,34 @@
# homepage Stack # 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 ## 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 ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|-----|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** homepage.netgrimoire.com, glance.netgrimoire.com (Caddy domains) - **Exposed via:** homepage.netgrimoire.com, glancenetgrimoire.com (via Caddy)
- **Homepage group:** homepage.group - **Homepage group:** homepage
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack.
This stack requires the `docker` command-line utility to be installed and configured.
### Volume Setup ### Volume Setup
```bash ```bash
@ -51,10 +54,7 @@ docker stack services homepage
### First Run ### First Run
Perform the following steps after deployment: After the initial deployment, ensure that all volumes are properly mounted and configured.
* Run `docker-compose up` to start the services.
* Configure the `HOMEPAGE_ALLOWED_HOSTS` environment variable with the desired hosts.
--- ---
@ -63,15 +63,13 @@ Perform the following steps after deployment:
### Accessing homepage ### Accessing homepage
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Host:** docker4, `homepage.netgrimoire.com` - **Caddy Reverse Proxy**: http://homepage:3056
### Primary Use Cases ### Primary Use Cases
To access the application's homepage, navigate to `http://homepage:3056` or `https://homepage.netgrimoire.com`.
This stack serves as the primary source for NetGrimoire's homepage. It can be accessed by visiting the specified Caddy domain or hostname.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services via environment variables and labels. Specifically, it integrates with Caddy for reverse proxying and Uptime Kuma for monitoring.
This stack integrates with other services in the NetGrimoire environment through environment variables and labels, including `kuma.*` monitors and `homepage.group`.
--- ---
@ -80,11 +78,11 @@ This stack integrates with other services in the NetGrimoire environment through
### Monitoring ### Monitoring
```bash ```bash
docker stack services homepage docker stack services homepage
docker-compose logs -f homepage docker-compose -f /etc/kubernetes/adminstack/up kuma.yml logs -f
``` ```
### Backups ### 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 ### Restore
```bash ```bash
@ -95,12 +93,10 @@ cd services/swarm/stack/homepage
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
1. Service not responding | Incorrect configuration or missing dependencies | Review and correct environment variables, ensure all required packages are installed. - Caddy Reverse Proxy not working | Insufficient configuration or missing environment variables. | Review and update Caddy configuration and environment variables.
2. No reverse proxying | Caddy configuration issues or incorrect labels | Check Caddy logs for errors, verify the `caddy-docker-proxy` label is applied correctly. - Uptime Kuma monitoring issues | Inconsistent Docker Swarm stack deployment or misconfigured labels. | Verify that the `kuma.*` labels are correctly applied to the service.
3. Network connectivity issues | External network issues or incorrect routing table entries | Verify network connections and routing table entries.
--- ---
@ -108,10 +104,17 @@ cd services/swarm/stack/homepage
| Date | Commit | Summary | | 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. |
<This service has undergone significant changes in its recent commits, including updates to Caddy reverse proxy configuration and Uptime Kuma monitoring integration. Review these sections to ensure you're familiar with the latest implementation details.>
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-07T00:45:36.511Z - Generated by Gremlin on 2026-04-07T00:49:28.119Z
- Source: swarm/stack/homepage/homepage.yaml - Source: swarm/homepage.yaml
- Review User Guide and Changelog sections