From d1bcda1aa3897fac34e88da550560c06b6db54fb Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 23:15:49 -0500 Subject: [PATCH] docs(gremlin): update firefox --- Netgrimoire/Services/firefox/firefox.md | 62 +++++++++++-------------- 1 file changed, 28 insertions(+), 34 deletions(-) diff --git a/Netgrimoire/Services/firefox/firefox.md b/Netgrimoire/Services/firefox/firefox.md index b6c66ac..3830455 100644 --- a/Netgrimoire/Services/firefox/firefox.md +++ b/Netgrimoire/Services/firefox/firefox.md @@ -2,37 +2,38 @@ title: firefox Stack description: Remote Browser for NetGrimoire published: true -date: 2026-04-30T04:12:27.879Z +date: 2026-04-30T04:12:31.015Z tags: docker,swarm,firefox,netgrimoire editor: markdown -dateCreated: 2026-04-30T04:12:27.879Z +dateCreated: 2026-04-30T04:12:31.015Z --- # firefox ## Overview -The firefox stack is a NetGrimoire service that provides a remote browser interface for accessing web applications. The primary service is the `firefox` container, which runs in Docker Swarm mode. +The firefox stack provides a remote browser service for NetGrimoire, allowing users to access a fully functional Firefox instance from within the network. + +--- ## Architecture - | Service | Image | Port | Role | |---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire - **Exposed via:** firefox.netgrimoire.com -- **Homepage group:** homepage.group: "Remote Access" +- **Homepage group:** Remote Access --- ## Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +Ensure the environment is set up with the necessary Docker Swarm configuration files and environment variables. ### Volume Setup ```bash mkdir -p /DockerVol/firefox -chown -R firefox:firefox /DockerVol/firefox +chown -R user:group /DockerVol/firefox ``` ### Environment Variables @@ -41,7 +42,6 @@ chown -R firefox:firefox /DockerVol/firefox PUID=1964 PGID=1964 TZ=America/Chicago -# add any other environment variables here ``` ### Deploy @@ -55,50 +55,47 @@ docker stack services firefox ``` ### First Run -After the initial deployment, ensure that the `firefox` container is running and accessible at the exposed URL. +After deployment, ensure that the `firefox` service is running and accessible through the Caddy reverse proxy. --- ## User Guide ### Accessing firefox -| Service | URL | Purpose | -|---------|-----|---------| -- **firefox** | http://firefox.netgrimoire.com | Remote Browser Interface | +| Service | URL | +|---------|-----| +Caddy: firefox.netgrimoire.com ### Primary Use Cases -To access web applications using the remote browser interface, navigate to the `http://firefox.netgrimoire.com` URL in a supported browser. +Use this service to access a remote Firefox instance for testing, development, or collaboration purposes within NetGrimoire. ### NetGrimoire Integrations -This service integrates with other NetGrimoire services through environment variables and labels, including Kuma for monitoring and Uptime Kuma for uptime checks. +This service integrates with other NetGrimoire services through environment variables and labels, including Uptime Kuma monitoring and the Homepage dashboard. --- ## Operations ### Monitoring +Monitor the `firefox` service using Uptime Kuma. ```bash docker stack services firefox docker service logs firefox ``` ### Backups -Critical data is stored in the `/DockerVol/firefox` volume. Regular backups are recommended to ensure data integrity. +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. ### Restore -To restore the `firefox` container from a backup, run the following command: -```bash -cd services/swarm/stack/firefox -./deploy.sh -``` +Restore the `firefox` service by running the `deploy.sh` script in the `services/swarm/stack/firefox` directory. --- ## Common Failures | Symptom | Cause | Fix | -|---------|------|-----| -| Container not running | Insufficient resources or network issues | Check resource allocation and ensure network connectivity | -| Browser interface not accessible | Incorrect environment variables or configuration | Verify environment variables and configuration files | +|---------|-------|-----| +| 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. | --- @@ -106,18 +103,15 @@ cd services/swarm/stack/firefox | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | a1853fe4 | Initial documentation for firefox stack | -| 2026-04-29 | 229d8cbd | Added kuma.* labels for monitoring integration | -| 2026-03-03 | 5ada055a | Improved volume setup and permissions | -| 2026-03-03 | 8dd63040 | Enhanced security measures for environment variables | -| 2026-01-10 | 1a374911 | Initial implementation of firefox stack | - - -The firefox stack has undergone several improvements and refinements since its initial implementation. The recent commits have enhanced security measures, improved volume setup, and added monitoring integration through Kuma labels. +| 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 | --- ## Notes -- Generated by Gremlin on 2026-04-30T04:12:27.879Z -- Source: swarm/firefox.yaml -- Review User Guide and Changelog sections \ No newline at end of file +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