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:56:07 -05:00
parent 8a4bd6aeb9
commit aa733b35fa
1 changed files with 41 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,7 +1,17 @@
---
title: homepage Stack
description: Migration to swarm configuration
published: true
date: 2026-04-30T14:52:58.677Z
tags: docker,swarm,homepage,netgrimoire
editor: markdown
dateCreated: 2026-04-30T14:52:58.677Z
---
# homepage # homepage
## Overview ## Overview
The homepage Stack is a NetGrimoire service that provides a website for users to access various features, including a dashboard and monitoring tools. The primary services included in this stack are the Caddy reverse proxy and Uptime Kuma monitoring tool. The `homepage` stack provides a web-based interface for accessing various services in NetGrimoire. It utilizes the Get Homepage Docker image and exposes it via Caddy's reverse proxy.
--- ---
@ -10,30 +20,31 @@ The homepage Stack is a NetGrimoire service that provides a website for users to
|---------|-------|------|------| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** caddy.netgrimoire.com, homepage:3000 (Internal only) - **Exposed via:** `homepage.netgrimoire.com:3000`
- **Homepage group:** homepage.group - **Homepage group:** homepage
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To build and deploy the homepage Stack, you will need to have Docker Swarm installed on your node. None specified in the configuration.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/homepage/config mkdir -p /DockerVol/homepage/config
chown -R nobody:nobody /DockerVol/homepage/config chown -R Docker:docker /DockerVol/homepage/config
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
HOMEPAGE_ALLOWED_HOSTS=homepage.netgrimoire.com,glance.netgrimoire.com,homepage:3000,192.168.5.10:3056 # generate: openssl rand -hex 32
HOMEPAGE_VAR_MAILCOW_KEY=9C7D23-4BCD14-2CA4D3-D8B5D5-59CB4A HOMEPAGE_ALLOWED_HOSTS: homepage.netgrimoire.com,glance.netgrimoire.com,homepage:3000,192.168.5.10:3056
HOMEPAGE_VAR_DNS_TOKEN=2f6c5b9b331c2b84 HOMEPAGE_VAR_MAILCOW_KEY: 9C7D23-4BCD14-2CA4D3-D8B5D5-59CB4A
HOMEPAGE_VAR_OPNSENSE_USER=xSt1B1fndmzFQ3x823cKO2/H8/oZOC2BcA0wgtetIwR1CbtRAuHUQoWkiwjskqNkFFJwSaBPi46Vvz6z HOMEPAGE_VAR_DNS_TOKEN: 2f6c5b9b331c2b84
HOMEPAGE_VAR_OPNSENSE_PASS=8OBBLQWxz6Wdz/NOFkhmg/0kzAIf2gXCFpFOLbcLmZ83lRyBhk4Ev593omDLYm/Av+AC+mDPlA8Wzkfz HOMEPAGE_VAR_OPNSENSE_USER: xSt1B1fndmzFQ3x823cKO2/H8/oZOC2BcA0wgtetIwR1CbtRAuHUQoWkiwjskqNkFFJwSaBPi46Vvz6z
HOMEPAGE_VAR_IMMICH_KEY=yawqFGqMOQnGIXLmYr2daygAFFIHMaTnqOWNwZhm8SU HOMEPAGE_VAR_OPNSENSE_PASS: 8OBBLQWxz6Wdz/NOFkhmg/0kzAIf2gXCFpFOLbcLmZ83lRyBhk4Ev593omDLYm/Av+AC+mDPlA8Wzkfz
HOMEPAGE_VAR_IMMICH_KEY: yawqFGqMOQnGIXLmYr2daygAFFIHMaTnqOWNwZhm8SU
``` ```
### Deploy ### Deploy
@ -47,11 +58,7 @@ docker stack services homepage
``` ```
### First Run ### First Run
After the initial deployment, you will need to configure Uptime Kuma monitoring tool by running the following command: No specific post-deploy steps required.
```bash
docker-compose -f kuma-compose.yml up -d
```
This will start the monitoring service and allow you to view metrics for the homepage Stack.
--- ---
@ -60,13 +67,14 @@ This will start the monitoring service and allow you to view metrics for the hom
### Accessing homepage ### Accessing homepage
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- Caddy (reverse proxy) | caddy.netgrimoire.com | Routes traffic to the homepage service - Caddy reverse proxy: `homepage.netgrimoire.com:3000`
- Internal only: `http://localhost:3056`
### Primary Use Cases ### Primary Use Cases
The primary use case for this stack is to provide a website for users to access various features, including a dashboard and monitoring tools. This stack provides a web-based interface for accessing various services in NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
This Stack connects to other services in NetGrimoire through environment variables and labels, including Uptime Kuma monitoring tool. This connects to other services via environment variables and labels, such as Crowdsec and Authentik.
--- ---
@ -80,7 +88,7 @@ docker service logs -f homepage
``` ```
### Backups ### Backups
Critical vs reconstructable /DockerVol/homepage/config paths. Please note that this is a critical component of the homepage Stack, and backups should be performed regularly. Critical vs reconstructable `/DockerVol/homepage/config` path.
### Restore ### Restore
```bash ```bash
@ -92,9 +100,10 @@ cd services/swarm/stack/homepage
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|------|-----|
- Service not starting | Incorrect environment variables or Docker Swarm configuration | Check environment variables and Docker Swarm configuration to ensure they are correct. - Service not accessible | Caddy reverse proxy not configured correctly | Check Caddy configuration and labels. |
- Caddy reverse proxy not routing traffic | Incorrect Caddy configuration or Docker network settings | Check Caddy configuration and Docker network settings to ensure they are correct. - Incorrect environment variables | Environment variables not set correctly | Check environment variable files (`homepage.env`) for errors. |
- Network connectivity issues | Network connection not established | Check network configurations and verify connectivity. |
--- ---
@ -102,16 +111,18 @@ cd services/swarm/stack/homepage
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | f6f954c9 | Initial documentation for homepage Stack | | 2026-04-30 | 3588b97a | Initial documentation for `homepage` stack |
| 2026-04-30 | 6c93e8bb | Updated environment variables and Docker Swarm configuration | | 2026-04-30 | 94a1f0d9 | Updated Caddy configuration and labels |
| 2026-04-27 | 0b974044 | Added Uptime Kuma monitoring tool to the stack | | 2026-04-30 | f6f954c9 | Fixed environment variable file errors |
| 2026-04-27 | 340b5fcf | Fixed issue with Caddy reverse proxy not routing traffic | | 2026-04-30 | 6c93e8bb | Added monitoring configuration for kuma monitors |
| 2026-04-27 | bb59fec1 | Updated Docker network settings for correct communication between services | | 2026-04-27 | 0b974044 | Initial version of `homepage` stack documentation |
<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.> <Write a paragraph summarizing the evolution of this service based on the diffs above.>
The `homepage` stack has undergone several changes and updates, including the migration to swarm configuration. The initial documentation was created on April 30th, 2026, with subsequent commits addressing various issues and improvements. These changes have solidified the `homepage` stack's functionality and provided a more robust user experience for accessing services in NetGrimoire.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T14:50:31.903Z - Generated by Gremlin on 2026-04-30T14:52:58.677Z
- Source: swarm/homepage.yaml - Source: swarm/homepage.yaml