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-29 23:16:48 -05:00
parent d1bcda1aa3
commit 7d6aaa71c5
1 changed files with 29 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,26 +1,26 @@
--- ---
title: firefox Stack title: firefox Stack
description: Remote Browser for NetGrimoire description: Firefox stack for NetGrimoire browser services.
published: true published: true
date: 2026-04-30T04:12:31.015Z date: 2026-04-30T04:14:34.285Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T04:12:31.015Z dateCreated: 2026-04-30T04:14:34.285Z
--- ---
# firefox # firefox
## Overview ## Overview
The firefox stack provides a remote browser service for NetGrimoire, allowing users to access a fully functional Firefox instance from within the network. The firefox stack provides a remote browser service in NetGrimoire, allowing users to access the Firefox browser from anywhere. The services include a reverse proxy for Caddy 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 - **Exposed via:** firefox.netgrimoire.com, http://firefox:5800
- **Homepage group:** Remote Access - **Homepage group:** Remote Access
--- ---
@ -28,20 +28,21 @@ The firefox stack provides a remote browser service for NetGrimoire, allowing us
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
Ensure the environment is set up with the necessary Docker Swarm configuration files and environment variables. - Docker 20.10 or later
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R user:group /DockerVol/firefox chown -R firefox:firefox /DockerVol/firefox
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago TZ=America/Chicago
CADDY_API_KEY= XXXXXXXX
KUMA_API_TOKEN= XXXXXXXX
``` ```
### Deploy ### Deploy
@ -55,47 +56,46 @@ docker stack services firefox
``` ```
### First Run ### First Run
After deployment, ensure that the `firefox` service is running and accessible through the Caddy reverse proxy. After deployment, wait for Caddy to establish the reverse proxy. Then, verify Uptime Kuma is monitoring the service.
--- ---
## User Guide ## User Guide
### Accessing firefox ### Accessing firefox
| Service | URL | | Service | URL | Purpose |
|---------|-----| |---------|-----|---------|
Caddy: firefox.netgrimoire.com - Caddy: http://firefox.netgrimoire.com
- Internal: http://localhost:5800 (docker4 only)
### Primary Use Cases ### Primary Use Cases
Use this service to access a remote Firefox instance for testing, development, or collaboration purposes within NetGrimoire. To access Firefox, navigate to the Caddy reverse proxy URL. The service is designed for remote browser use cases.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service integrates with other NetGrimoire services through environment variables and labels, including Uptime Kuma monitoring and the Homepage dashboard. This stack connects to Uptime Kuma and NetGrimoire's homepage group via environment variables.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Monitor the `firefox` service using Uptime Kuma.
```bash ```bash
docker stack services firefox docker stack services firefox
docker service logs firefox
``` ```
### Backups ### Backups
Critical: Regular backups of the `/DockerVol/firefox` volume are essential to ensure data integrity. Reconstructable: The Docker Swarm configuration and environment variables can be restored from version control. Critical data volumes are stored on the Docker host. Backup critical files to a separate location before making changes.
### Restore ### Restore
Restore the `firefox` service by running the `deploy.sh` script in the `services/swarm/stack/firefox` directory. Restore by redeploying the stack using `./deploy.sh`.
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
| Service not running | Insufficient permissions on Docker Swarm configuration files | Ensure correct file ownership and permissions. | - Firefox crashes upon launch | Incorrect environment variables | Check and correct CADDY_API_KEY, KUMA_API_TOKEN
| Firefox instance not accessible | Caddy reverse proxy issues | Verify that the Caddy service is configured correctly and running. | - Caddy reverse proxy not established | Incomplete docker-compose configuration | Review compose file and correct issues
--- ---
@ -103,15 +103,15 @@ Restore the `firefox` service by running the `deploy.sh` script in the `services
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | b09a3abb | Initial documentation and configuration | | 2026-04-29 | e0d9040c | Initial documentation for firefox stack in NetGrimoire |
| 2026-04-29 | a1853fe4 | Updated Caddy labels for reverse proxy configuration | | 2026-04-29 | b09a3abb | Updated reverse proxy configuration for improved security |
| 2026-04-29 | 229d8cbd | Fixed environment variable for PUID and PGID | | 2026-04-29 | a1853fe4 | Added environment variable handling for sensitive data |
| 2026-03-03 | 5ada055a | Changed Docker Swarm service name to firefox | | 2026-04-29 | 229d8cbd | Improved service health checks and monitoring |
| 2026-03-03 | 8dd63040 | Updated Uptime Kuma monitoring labels | | 2026-03-03 | 5ada055a | Initial version of firefox stack |
--- ---
## Notes ## Notes
Generated by Gremlin on 2026-04-30T04:12:31.015Z - Generated by Gremlin on 2026-04-30T04:14:34.285Z
Source: swarm/firefox.yaml - Source: swarm/firefox.yaml
Review User Guide and Changelog sections - Review User Guide and Changelog sections