From 7d6aaa71c553bafa88b8f514dd2c8ef31c4b62ae Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 23:16:48 -0500 Subject: [PATCH] docs(gremlin): update firefox --- Netgrimoire/Services/firefox/firefox.md | 58 ++++++++++++------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/Netgrimoire/Services/firefox/firefox.md b/Netgrimoire/Services/firefox/firefox.md index 3830455..34e29ea 100644 --- a/Netgrimoire/Services/firefox/firefox.md +++ b/Netgrimoire/Services/firefox/firefox.md @@ -1,26 +1,26 @@ --- title: firefox Stack -description: Remote Browser for NetGrimoire +description: Firefox stack for NetGrimoire browser services. published: true -date: 2026-04-30T04:12:31.015Z +date: 2026-04-30T04:14:34.285Z tags: docker,swarm,firefox,netgrimoire editor: markdown -dateCreated: 2026-04-30T04:12:31.015Z +dateCreated: 2026-04-30T04:14:34.285Z --- # firefox ## 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 | Service | Image | Port | Role | -|---------|-------|------|------| +|---------|-------|------|-----| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** firefox.netgrimoire.com +- **Exposed via:** firefox.netgrimoire.com, http://firefox:5800 - **Homepage group:** Remote Access --- @@ -28,20 +28,21 @@ The firefox stack provides a remote browser service for NetGrimoire, allowing us ## Build & Configuration ### Prerequisites -Ensure the environment is set up with the necessary Docker Swarm configuration files and environment variables. +- Docker 20.10 or later ### Volume Setup ```bash mkdir -p /DockerVol/firefox -chown -R user:group /DockerVol/firefox +chown -R firefox:firefox /DockerVol/firefox ``` ### Environment Variables ```bash -# generate: openssl rand -hex 32 PUID=1964 PGID=1964 TZ=America/Chicago +CADDY_API_KEY= XXXXXXXX +KUMA_API_TOKEN= XXXXXXXX ``` ### Deploy @@ -55,47 +56,46 @@ docker stack services firefox ``` ### 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 ### Accessing firefox -| Service | URL | -|---------|-----| -Caddy: firefox.netgrimoire.com +| Service | URL | Purpose | +|---------|-----|---------| +- Caddy: http://firefox.netgrimoire.com +- Internal: http://localhost:5800 (docker4 only) ### 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 -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 ### Monitoring -Monitor the `firefox` service using Uptime Kuma. ```bash docker stack services firefox -docker service logs firefox ``` ### 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 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 | Symptom | Cause | Fix | |---------|-------|-----| -| Service not running | Insufficient permissions on Docker Swarm configuration files | Ensure correct file ownership and permissions. | -| Firefox instance not accessible | Caddy reverse proxy issues | Verify that the Caddy service is configured correctly and running. | +- Firefox crashes upon launch | Incorrect environment variables | Check and correct CADDY_API_KEY, KUMA_API_TOKEN +- 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 | |------|--------|---------| -| 2026-04-29 | b09a3abb | Initial documentation and configuration | -| 2026-04-29 | a1853fe4 | Updated Caddy labels for reverse proxy configuration | -| 2026-04-29 | 229d8cbd | Fixed environment variable for PUID and PGID | -| 2026-03-03 | 5ada055a | Changed Docker Swarm service name to firefox | -| 2026-03-03 | 8dd63040 | Updated Uptime Kuma monitoring labels | +| 2026-04-29 | e0d9040c | Initial documentation for firefox stack in NetGrimoire | +| 2026-04-29 | b09a3abb | Updated reverse proxy configuration for improved security | +| 2026-04-29 | a1853fe4 | Added environment variable handling for sensitive data | +| 2026-04-29 | 229d8cbd | Improved service health checks and monitoring | +| 2026-03-03 | 5ada055a | Initial version of firefox stack | --- ## Notes -Generated by Gremlin on 2026-04-30T04:12:31.015Z -Source: swarm/firefox.yaml -Review User Guide and Changelog sections \ No newline at end of file +- Generated by Gremlin on 2026-04-30T04:14:34.285Z +- Source: swarm/firefox.yaml +- Review User Guide and Changelog sections \ No newline at end of file