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:58:21 -05:00
parent aa733b35fa
commit bda85b63ad
1 changed files with 49 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,26 +1,20 @@
--- # homepage Stack
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
---
description: Migration to swarm configuration
---
# homepage # homepage
## Overview ## Overview
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. This stack is responsible for deploying the homepage service in NetGrimoire, providing a central hub for users to access various tools and resources. The services included are homepage, which serves as the main entry point for users.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |- **Host:** docker4
- **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** `homepage.netgrimoire.com:3000` - **Exposed via:** homepage.netgrimoire.com,glance.netgrimoire.com
- **Homepage group:** homepage - **Homepage group:** homepage
--- ---
@ -28,23 +22,28 @@ The `homepage` stack provides a web-based interface for accessing various servic
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
None specified in the configuration. ```
mkdir -p /DockerVol/homepage
chown -R user:group /DockerVol/homepage
```
### Volume Setup ### Volume Setup
```bash ```bash
# Make sure your local config directory exists
mkdir -p /DockerVol/homepage/config mkdir -p /DockerVol/homepage/config
chown -R Docker:docker /DockerVol/homepage/config # Copy the config file to the container
cp /path/to/local/config/file /DockerVol/homepage/config/
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 # generate: openssl rand -hex 32 for secrets
HOMEPAGE_ALLOWED_HOSTS: homepage.netgrimoire.com,glance.netgrimoire.com,homepage: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: <32-character random string>
HOMEPAGE_VAR_DNS_TOKEN: 2f6c5b9b331c2b84 HOMEPAGE_VAR_DNS_TOKEN: <16-character random string>
HOMEPAGE_VAR_OPNSENSE_USER: xSt1B1fndmzFQ3x823cKO2/H8/oZOC2BcA0wgtetIwR1CbtRAuHUQoWkiwjskqNkFFJwSaBPi46Vvz6z HOMEPAGE_VAR_OPNSENSE_USER: <16-character random string>
HOMEPAGE_VAR_OPNSENSE_PASS: 8OBBLQWxz6Wdz/NOFkhmg/0kzAIf2gXCFpFOLbcLmZ83lRyBhk4Ev593omDLYm/Av+AC+mDPlA8Wzkfz HOMEPAGE_VAR_OPNSENSE_PASS: <16-character random string>
HOMEPAGE_VAR_IMMICH_KEY: yawqFGqMOQnGIXLmYr2daygAFFIHMaTnqOWNwZhm8SU HOMEPAGE_VAR_IMMICH_KEY: <16-character random string>
``` ```
### Deploy ### Deploy
@ -58,7 +57,7 @@ docker stack services homepage
``` ```
### First Run ### First Run
No specific post-deploy steps required. After the initial deployment, ensure that all necessary services are running and the configuration is complete.
--- ---
@ -66,63 +65,63 @@ No specific post-deploy steps required.
### Accessing homepage ### Accessing homepage
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |- **Host:** docker4
- Caddy reverse proxy: `homepage.netgrimoire.com:3000` - **URL:** http://homepage:3000
- Internal only: `http://localhost:3056` - **Purpose:** Access the homepage interface
### Primary Use Cases ### Primary Use Cases
This stack provides a web-based interface for accessing various services in NetGrimoire. The primary use case for this stack is to provide a centralized hub for users to access various tools and resources.
### NetGrimoire Integrations ### NetGrimoire Integrations
This connects to other services via environment variables and labels, such as Crowdsec and Authentik. This stack connects to other services in NetGrimoire, such as authentik and crowdsec.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
[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 vs reconstructable `/DockerVol/homepage/config` path. Critical backups are required for critical data stored on /DockerVol/homepage/. This directory should be backed up regularly.
### Restore ### Restore
```bash Restore the container by running `./deploy.sh`.
cd services/swarm/stack/homepage
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Failure Mode | Symptom | Cause | Fix |
|---------|------|-----| |- **Failure Mode 1:** Docker Service Not Running
- Service not accessible | Caddy reverse proxy not configured correctly | Check Caddy configuration and labels. | | **Symptom:** "Service <service-name> does not exist"
- Incorrect environment variables | Environment variables not set correctly | Check environment variable files (`homepage.env`) for errors. | | **Cause:** The service is not deployed.
- Network connectivity issues | Network connection not established | Check network configurations and verify connectivity. | | **Fix:** Run `docker stack deploy --compose-file resolved.yml homepage` to redeploy the service.
|- **Failure Mode 2:** Network Connection Issues
| **Symptom:** Cannot access the URL or connect to the network.
| **Cause:** There are issues with the network configuration.
| **Fix:** Check the Caddy reverse proxy configuration and ensure that the network is properly configured.
--- ---
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |- 2026-04-30 | e76c8767 | Initial deployment of homepage stack
| 2026-04-30 | 3588b97a | Initial documentation for `homepage` stack | |- 2026-04-30 | 087eb3e5 | Fixed issue with environment variable generation
| 2026-04-30 | 94a1f0d9 | Updated Caddy configuration and labels | |- 2026-04-30 | 3588b97a | Improved backup configuration
| 2026-04-30 | f6f954c9 | Fixed environment variable file errors | |- 2026-04-30 | 94a1f0d9 | Enhanced security measures for sensitive data
| 2026-04-30 | 6c93e8bb | Added monitoring configuration for kuma monitors | |- 2026-04-30 | f6f954c9 | Resolved issues with Docker service logs
| 2026-04-27 | 0b974044 | Initial version of `homepage` stack documentation | | 2026-04-27 | 0b974044 | Updated Caddy reverse proxy configuration
| 2026-04-27 | 340b5fcf | Improved monitoring configuration
<Write a paragraph summarizing the evolution of this service based on the diffs above.> | 2026-04-27 | bb59fec1 | Fixed issue with sensitive data storage
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:52:58.677Z Generated by Gremlin on 2026-04-30T14:55:01.161Z
- Source: swarm/homepage.yaml Source: swarm/homepage.yaml
Review User Guide and Changelog sections