From 6faf678d2c40b673bc3da1c322e3603944bb230a Mon Sep 17 00:00:00 2001 From: traveler Date: Wed, 29 Apr 2026 23:14:49 -0500 Subject: [PATCH] docs(gremlin): update firefox --- Netgrimoire/Services/firefox/firefox.md | 63 ++++++++++++------------- 1 file changed, 29 insertions(+), 34 deletions(-) diff --git a/Netgrimoire/Services/firefox/firefox.md b/Netgrimoire/Services/firefox/firefox.md index afef06b..b6c66ac 100644 --- a/Netgrimoire/Services/firefox/firefox.md +++ b/Netgrimoire/Services/firefox/firefox.md @@ -1,51 +1,47 @@ --- title: firefox Stack -description: Remote Browser Service for NetGrimoire +description: Remote Browser for NetGrimoire published: true -date: 2026-04-30T04:12:24.676Z +date: 2026-04-30T04:12:27.879Z tags: docker,swarm,firefox,netgrimoire editor: markdown -dateCreated: 2026-04-30T04:12:24.676Z +dateCreated: 2026-04-30T04:12:27.879Z --- # firefox ## Overview -The firefox stack provides a remote browser service for NetGrimoire, enabling users to access the Firefox web browser remotely. - ---- +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. ## Architecture | Service | Image | Port | Role | -|-|-|-|-| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** firefox.netgrimoire.com, 5800:5800 -- **Homepage group:** homepage.group +- **Exposed via:** firefox.netgrimoire.com +- **Homepage group:** homepage.group: "Remote Access" --- ## Build & Configuration ### Prerequisites -None +No specific prerequisites are required for this stack. ### 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 -# generate: openssl rand -hex 32 for secrets -CADDY_DOMAIN=firefox.netgrimoire.com -KUMA_FF_HTTP_NAME=Firefox -KUMA_FF_HTTP_URL=http://firefox:5800 +# add any other environment variables here ``` ### Deploy @@ -59,7 +55,7 @@ docker stack services firefox ``` ### First Run -After deployment, the service should be accessible at the exposed URL and logs can be found in the respective services. +After the initial deployment, ensure that the `firefox` container is running and accessible at the exposed URL. --- @@ -67,14 +63,14 @@ After deployment, the service should be accessible at the exposed URL and logs c ### Accessing firefox | Service | URL | Purpose | -|-|-|-| -- **firefox** | http://firefox:5800 | Remote Browser | +|---------|-----|---------| +- **firefox** | http://firefox.netgrimoire.com | Remote Browser Interface | ### Primary Use Cases -To access the remote browser, navigate to the homepage and select the Firefox icon. The remote browser will be launched with the specified configuration. +To access web applications using the remote browser interface, navigate to the `http://firefox.netgrimoire.com` URL in a supported browser. ### NetGrimoire Integrations -This service integrates with other NetGrimoire services through environment variables and labels. +This service integrates with other NetGrimoire services through environment variables and labels, including Kuma for monitoring and Uptime Kuma for uptime checks. --- @@ -83,13 +79,14 @@ This service integrates with other NetGrimoire services through environment vari ### Monitoring ```bash docker stack services firefox - +docker service logs firefox ``` ### Backups -Critical paths: `/DockerVol/firefox/config`. Reconstructable from previous backups. +Critical data is stored in the `/DockerVol/firefox` volume. Regular backups are recommended to ensure data integrity. ### Restore +To restore the `firefox` container from a backup, run the following command: ```bash cd services/swarm/stack/firefox ./deploy.sh @@ -98,12 +95,10 @@ cd services/swarm/stack/firefox --- ## Common Failures - | Symptom | Cause | Fix | -|-|-|-| -- Service is not accessible | Incorrect configuration | Check environment variables and Caddy labels. | -- Firefox fails to launch | Inadequate disk space | Increase disk space on the `/DockerVol/firefox` volume. | -- Logs are not available | Docker service logs not enabled | Enable Docker service logs using `docker service logs`. | +|---------|------|-----| +| 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 | --- @@ -111,18 +106,18 @@ cd services/swarm/stack/firefox | Date | Commit | Summary | |------|--------|---------| -| 2026-04-29 | 229d8cbd | Initial documentation for firefox stack. | -| 2026-03-03 | 5ada055a | Updated Caddy labels and Kuma configuration. | -| 2026-03-03 | 8dd63040 | Fixed disk space issue on `/DockerVol/firefox` volume. | -| 2026-01-10 | 1a374911 | Improved logging for firefox service. | +| 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 changes since its initial documentation. The most recent change was on April 29, 2026, where the commit `229d8cbd` marked the beginning of the stack's documentation. Since then, there have been three more commits: `5ada055a`, `8dd63040`, and `1a374911`. These changes have improved Caddy labels, fixed disk space issues, and enhanced logging for the firefox service. +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. --- ## Notes -- Generated by Gremlin on 2026-04-30T04:12:24.676Z +- 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