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-30 09:52:33 -05:00
parent ebca8a00c7
commit b13f0b51f3
1 changed files with 42 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,19 +1,18 @@
# homepage Stack
description: A NetGrimoire service providing a web interface for accessing various features.
---
# homepage
## Overview
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.
The `homepage` stack is a critical component of NetGrimoire, providing a secure and scalable environment for users to access various services.
---
## Architecture
| Service | Image | Port | Role |
|---------|-----|-----|-----|
| 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 |
|---------|-------|------|------|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** `homepage.netgrimoire.com:3000`, `glance.netgrimoire.com:3056`
- **Homepage group:** `homepage.group`
---
@ -25,7 +24,7 @@ No specific prerequisites are required for this stack.
### Volume Setup
```bash
mkdir -p /DockerVol/homepage/config
chown -R 1001:1001 /DockerVol/homepage/config
chmod -R 755 /DockerVol/homepage/config
```
### Environment Variables
@ -50,7 +49,7 @@ docker stack services homepage
```
### First Run
No specific post-deploy steps are required for this service.
After deploying the `homepage` stack, ensure that all services are up and running. Verify that the `caddy` reverse proxy is configured correctly by checking the logs for any errors or warnings.
---
@ -59,26 +58,33 @@ No specific post-deploy steps are required for this service.
### Accessing homepage
| Service | URL | Purpose |
|---------|-----|---------|
| Homepage | http://homepage:3000 | Web interface for accessing various features |
- **Caddy:** `http://homepage.netgrimoire.com:3000`
- **Internal only:** `http://localhost:3000`
### Primary Use Cases
To access the web interface, navigate to `http://homepage:3000` in a web browser.
The `homepage` stack provides a centralized environment for users to access various services, including the `kuma` monitoring dashboard and the `caddy` reverse proxy.
### NetGrimoire Integrations
This service integrates with other services in NetGrimoire, such as Kuma and Authentik.
This stack connects to other services in NetGrimoire via environment variables and labels, including:
* `kuma.homepage.http.name`
* `kuma.homepage.http.url=http://homepage:3000`
* `caddy=homepage.netgrimoire.com`
* `caddy.import=authentik`
---
## Operations
### Monitoring
[kuma monitors from kuma.* labels]
```bash
docker stack services homepage
docker service logs -f homepage
<docker service logs commands>
```
### Backups
Critical: The `/DockerVol/homepage/config` volume should be backed up regularly to ensure data integrity.
Critical: `/DockerVol/homepage/config` and `/DockerVol/homepage/images` volumes should be backed up regularly to ensure data integrity.
### Restore
```bash
@ -89,10 +95,12 @@ cd services/swarm/stack/homepage
---
## Common Failures
| 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 |
| Symptom | Cause | Fix |
|---------|------|-----|
| `caddy` not reachable | `caddy` not started or configuration issues | Check `caddy` logs and verify configuration files |
| Service not available | Incorrect environment variable value or label mismatch | Verify environment variables and labels are correct |
| Volume permissions issues | Incorrect volume permissions | Set correct permissions using `chmod` |
---
@ -100,12 +108,17 @@ cd services/swarm/stack/homepage
| Date | Commit | Summary |
|------|--------|---------|
| 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 |
| 2026-04-30 | 6c93e8bb | Initial documentation creation |
| 2026-04-27 | 0b974044 | Fixed issue with caddy configuration |
| 2026-04-27 | 340b5fcf | Improved volume setup script |
| 2026-04-27 | bb59fec1 | Added environment variables for secure connections |
| 2026-04-06 | 7a9eb96d | Updated `docker stack` configuration to use `resolved.yml` |
<Generated by Gremlin on 2026-04-28T01:15:54.819Z>
<Source: swarm/homepage.yaml>
<Review User Guide and Changelog sections>
<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-30T14:50:30.426Z
- Source: swarm/homepage.yaml
- Review User Guide and Changelog sections