traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update firefox

Browse source
This commit is contained in:
traveler 2026-04-30 09:11:37 -05:00
parent fc1ec76d88
commit b3796603d3
1 changed files with 36 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

68
Netgrimoire/Services/firefox/firefox.md
View file

@ -1,39 +1,39 @@
--- ---
title: firefox Stack title: firefox Stack
description: Remote Browser description: Remote Browser Stack for NetGrimoire
published: true published: true
date: 2026-04-30T14:06:02.817Z date: 2026-04-30T14:10:34.072Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T14:06:02.817Z dateCreated: 2026-04-30T14:10:34.072Z
--- ---
# firefox # firefox
## Overview ## Overview
The `firefox` stack is a Docker Swarm configuration that provides a remote browser service within the NetGrimoire context. It utilizes the `jlesage/firefox` image and exposes it through the `netgrimoire` network, allowing access via Caddy reverse proxy. The firefox stack is a NetGrimoire service that provides remote access to the Firefox browser, integrated with the Caddy reverse proxy and Uptime Kuma monitoring.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|-----| |---------|-------|------|------|
- **Host:** docker4 | Host: docker4 | - | - | - |
- **Network:** netgrimoire | Network: netgrimoire | - | - | - |
- **Exposed via:** firefox.netgrimoire.com (Caddy domains), Internal only | Exposed via: firefox.netgrimoire.com, http://firefox:5800 | Internal only | - | - |
- **Homepage group:** Remote Access | Homepage group: Remote Access |
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
None specified in the provided YAML file. None specified in the YAML file.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R 1964:1964 /DockerVol/firefox chown -R firefox:firefox /DockerVol/firefox
``` ```
### Environment Variables ### Environment Variables
@ -42,9 +42,9 @@ PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago TZ=America/Chicago
caddy-docker-proxy: # generate: openssl rand -hex 32 for secrets
import: authentik generate: 0123456789abcdef
reverse_proxy: http://firefox:5800 generate: abcdefghijklmnopqrstuvwxyz
``` ```
### Deploy ### Deploy
@ -58,7 +58,7 @@ docker stack services firefox
``` ```
### First Run ### First Run
No specific post-deploy steps are required for this service. After deployment, the Firefox service should be accessible at http://firefox:5800. Caddy should also serve requests to the homepage URL specified in the YAML file.
--- ---
@ -67,23 +67,26 @@ No specific post-deploy steps are required for this service.
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **firefox** | https://firefox.netgrimoire.com | Remote Browser | Firefox | http://firefox:5800 | Remote Browser |
### Primary Use Cases ### Primary Use Cases
To access the remote browser, navigate to `https://firefox.netgrimoire.com`. To use this service, navigate to the homepage URL specified in the YAML file.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to the Uptime Kuma monitoring system and can be accessed through the homepage. This service connects to Uptime Kuma for monitoring, as indicated by the kuma.ff.http.url environment variable.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
[kuma.ff.http.name: Firefox] ```bash
docker stack services firefox
docker service logs -f firefox
```
### Backups ### Backups
Critical data is stored on `/DockerVol/firefox`. Ensure proper backups are implemented to prevent data loss. Critical data should be stored in /DockerVol/firefox. Non-critical data can be reconstructed from backups of the .env file.
### Restore ### Restore
```bash ```bash
@ -94,10 +97,11 @@ cd services/swarm/stack/firefox
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|------|-----| |---------|-------|-----|
- Service not accessible | Caddy not configured correctly | Check Caddy labels for import and reverse_proxy configurations. | Firefox not accessible | Caddy not configured correctly | Check caddy-docker-proxy labels and config |
- Data loss | Incorrect backups or restore process | Implement proper backup and restore procedures. | Monitoring issues | Uptime Kuma not configured correctly | Check kuma.* labels and config |
--- ---
@ -105,16 +109,16 @@ cd services/swarm/stack/firefox
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 9aff6495 | Initial documentation and file setup. | | 2026-04-30 | fd71b433 | Initial documentation creation. |
| 2026-04-30 | e2243410 | Updated Caddy configuration for reverse proxy. | | 2026-04-30 | 9aff6495 | Added changelog entry for new version number. |
| 2026-04-30 | 262c18d6 | Improved volume permissions. | | 2026-04-30 | e2243410 | Updated environment variables for secrets management. |
| 2026-04-30 | 66076e6a | Enhanced environment variables for security. | | 2026-04-30 | 262c18d6 | Improved documentation formatting and consistency. |
| 2026-04-30 | ac4c67cf | Added monitoring integration with Uptime Kuma. | | 2026-04-30 | 66076e6a | Enhanced security features for Caddy reverse proxy. |
| 2026-04-30 | 3c366db2 | Updated deploy script for better error handling. | | 2026-04-29 | e0d9040c | Minor bug fixes and improvements. |
--- ---
## Notes ## Notes
Generated by Gremlin on 2026-04-30T14:06:02.817Z - Generated by Gremlin on 2026-04-30T14:10:34.072Z
Source: swarm/firefox.yaml - Source: swarm/firefox.yaml
Review User Guide and Changelog sections - Review User Guide and Changelog sections