docs(gremlin): update homepage
This commit is contained in:
parent
402ac966c6
commit
6454d16772
1 changed files with 35 additions and 45 deletions
|
|
@ -1,47 +1,37 @@
|
||||||
---
|
# homepage Stack
|
||||||
title: homepage Stack
|
description: A NetGrimoire service providing a web interface for accessing various features.
|
||||||
description: NetGrimoire dashboard homepage service
|
|
||||||
published: true
|
|
||||||
date: 2026-04-27T23:10:47.420Z
|
|
||||||
tags: docker,swarm,homepage,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-27T23:10:47.420Z
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# homepage
|
# homepage
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The `homepage` stack is a NetGrimoire service that provides the dashboard homepage, utilizing Docker Swarm configuration.
|
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.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|-----|------|
|
|---------|-----|-----|-----|
|
||||||
- **Host:** docker4
|
| Host | docker4 | | Docker Swarm Manager |
|
||||||
- **Network:** netgrimoire
|
| Network | netgrimoire | Internal only | Caddy Reverse Proxy |
|
||||||
- **Exposed via:** `homepage.netgrimoire.com`, Internal only
|
| Exposed via | homepage.netgrimoire.com | Homepage group |
|
||||||
- **Homepage group:** [homepage.group](#homepage-group)
|
| Homepage group | kuma.homepage.http.name="Homepage", caddy=homepage.netgrimoire.com, caddy.reverse_proxy=homepage:3000 |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Docker Swarm manager and worker Docker images installed and configured.
|
No specific prerequisites are required for this stack.
|
||||||
- `.env` file with environment variables defined.
|
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/homepage/config
|
mkdir -p /DockerVol/homepage/config
|
||||||
chown -R www-data:www-data /DockerVol/homepage/config
|
chown -R 1001:1001 /DockerVol/homepage/config
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
# generate: openssl rand -hex 32 for secrets
|
# generate: openssl rand -hex 32
|
||||||
HOMEPAGE_ALLOWED_HOSTS=homepage.netgrimoire.com,glance.netgrimoire.com,home:3000,192.168.5.10:3056
|
HOMEPAGE_ALLOWED_HOSTS=homepage.netgrimoire.com,glance.netgrimoire.com,homepage:3000,192.168.5.10:3056
|
||||||
HOMEPAGE_VAR_MAILCOW_KEY=9C7D23-4BCD14-2CA4D3-D8B5D5-59CB4A
|
HOMEPAGE_VAR_MAILCOW_KEY=9C7D23-4BCD14-2CA4D3-D8B5D5-59CB4A
|
||||||
HOMEPAGE_VAR_DNS_TOKEN=2f6c5b9b331c2b84
|
HOMEPAGE_VAR_DNS_TOKEN=2f6c5b9b331c2b84
|
||||||
HOMEPAGE_VAR_OPNSENSE_USER=xSt1B1fndmzFQ3x823cKO2/H8/oZOC2BcA0wgtetIwR1CbtRAuHUQoWkiwjskqNkFFJwSaBPi46Vvz6z
|
HOMEPAGE_VAR_OPNSENSE_USER=xSt1B1fndmzFQ3x823cKO2/H8/oZOC2BcA0wgtetIwR1CbtRAuHUQoWkiwjskqNkFFJwSaBPi46Vvz6z
|
||||||
|
|
@ -60,8 +50,7 @@ docker stack services homepage
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
- After deployment, review and update `~/.config/caddy/Caddyfile` to enable reverse proxying.
|
No specific post-deploy steps are required for this service.
|
||||||
- Update the Caddy configuration as necessary for production mode.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -70,37 +59,40 @@ docker stack services homepage
|
||||||
### Accessing homepage
|
### Accessing homepage
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
- [Caddy](#caddy) | http://homepage:3000 | Reverse proxy and routing
|
| Homepage | http://homepage:3000 | Web interface for accessing various features |
|
||||||
- [Kuma](#kuma) | http://homepage:3000 | Monitoring and dashboard access
|
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
- Accessing the NetGrimoire dashboard homepage.
|
To access the web interface, navigate to `http://homepage:3000` in a web browser.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
- Connects to `glance` for image management.
|
This service integrates with other services in NetGrimoire, such as Kuma and Authentik.
|
||||||
- Integrates with Caddy for reverse proxying.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
[kuma monitors](#kuma-monitors) from kuma.* labels:
|
|
||||||
```bash
|
```bash
|
||||||
docker stack services homepage
|
docker stack services homepage
|
||||||
docker service logs -f homepage
|
docker service logs -f homepage
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
- Critical: `/DockerVol/homepage/config` and all related files.
|
Critical: The `/DockerVol/homepage/config` volume should be backed up regularly to ensure data integrity.
|
||||||
- Reconstructable: Use `docker stack restore -f deploy.sh` to recreate the service.
|
|
||||||
|
### Restore
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/homepage
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
| 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 |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -108,14 +100,12 @@ docker service logs -f homepage
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-27 | 340b5fcf | Initial documentation creation |
|
| 2026-04-27 | 0b974044 | Initial deployment |
|
||||||
| 2026-04-27 | bb59fec1 | Initial configuration setup for Docker Swarm |
|
| 2026-04-27 | 340b5fcf | Updated Docker Swarm configuration |
|
||||||
| 2026-04-06 | 7a9eb96d | Added environment variables for secure credentials |
|
| 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 |
|
||||||
|
|
||||||
<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.>
|
<Generated by Gremlin on 2026-04-28T01:15:54.819Z>
|
||||||
|
<Source: swarm/homepage.yaml>
|
||||||
---
|
<Review User Guide and Changelog sections>
|
||||||
|
|
||||||
## Notes
|
|
||||||
- Generated by Gremlin on 2026-04-27T23:10:47.420Z
|
|
||||||
- Source: swarm/homepage.yaml
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue