From 1df4697ff94c444062a0b32dfede3278f68fd88e Mon Sep 17 00:00:00 2001 From: traveler Date: Thu, 30 Apr 2026 09:24:13 -0500 Subject: [PATCH] docs(gremlin): update firefox --- Netgrimoire/Services/firefox/firefox.md | 165 ++++++++++++++++++------ 1 file changed, 123 insertions(+), 42 deletions(-) diff --git a/Netgrimoire/Services/firefox/firefox.md b/Netgrimoire/Services/firefox/firefox.md index b7b38d4..6a18c26 100644 --- a/Netgrimoire/Services/firefox/firefox.md +++ b/Netgrimoire/Services/firefox/firefox.md @@ -1,37 +1,74 @@ # firefox Stack -description: Remote Browser + +description: Remote Browser for NetGrimoire --- +title: firefox +published: true +date: 2026-04-30T14:22:18.852Z +tags: docker,swarm,firefox,netgrimoire +editor: markdown +dateCreated: 2026-04-30T14:22:18.852Z + +--- + +# firefox + ## Overview -The `firefox` stack is a Docker Swarm configuration that provides remote access to the Firefox browser in NetGrimoire. + +The firefox stack provides a remote access to the Firefox browser for use within NetGrimoire. It is composed of a single service that utilizes the `jlesage/firefox` Docker image. + +--- +title: firefox +published: true +date: 2026-04-30T14:22:18.852Z +tags: docker,swarm,firefox,netgrimoire +editor: markdown +dateCreated: 2026-04-30T14:22:18.852Z --- ## Architecture + | Service | Image | Port | Role | -|---------|-----|-----|-----| +|---------|-----|-----|---------| +| firefox | jlesage/firefox | 5800:5900 | Remote Browser | + - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** firefox.netgrimoire.com, 5800:5800 +- **Exposed via:** firefox.netgrimoire.com, firefox:5800 - **Homepage group:** Remote Access +--- +title: firefox +published: true +date: 2026-04-30T14:22:18.852Z +tags: docker,swarm,firefox,netgrimoire +editor: markdown +dateCreated: 2026-04-30T14:22:18.852Z + --- ## Build & Configuration ### Prerequisites -None required. + +* Docker Swarm and Caddy must be installed. ### Volume Setup ```bash mkdir -p /DockerVol/firefox -chown -R firefox:firefox /DockerVol/firefox +chown -R 1964:1964 /DockerVol/firefox ``` ### Environment Variables ```bash -generate: openssl rand -hex 32 -POODLE disable: true +PUID=1964 +PGID=1964 +TZ=America/Chicago +GREMLIN_VERSION=2026-04-1 + +# generate: openssl rand -hex 32 for secrets ``` ### Deploy @@ -45,59 +82,93 @@ docker stack services firefox ``` ### First Run -No specific post-deploy steps are required. + +* The Firefox browser must be updated to the latest version. +* Any necessary configuration files must be created or copied. + +--- +title: firefox +published: true +date: 2026-04-30T14:22:18.852Z +tags: docker,swarm,firefox,netgrimoire +editor: markdown +dateCreated: 2026-04-30T14:22:18.852Z --- ## User Guide ### Accessing firefox -| Service | URL | Purpose | -- **firefox** | http://firefox:5800 | Remote Browser | + +| Service | URL | +|---------|-----| +| firefox | http://firefox.netgrimoire.com | ### Primary Use Cases -To access the Firefox browser in NetGrimoire, navigate to the specified URL. + +* Remote access to the Firefox browser. +* Usage as a remote control. ### NetGrimoire Integrations -The `firefox` stack integrates with other services such as Caddy and Authentik. + +* Monitors and is monitored by Uptime Kuma. +* Displays information on the homepage. + +--- +title: firefox +published: true +date: 2026-04-30T14:22:18.852Z +tags: docker,swarm,firefox,netgrimoire +editor: markdown +dateCreated: 2026-04-30T14:22:18.852Z --- ## Operations ### Monitoring + +* `kuma.*` labels are used to monitor the service. + ```bash docker stack services firefox -docker service logs firefox --after 120s +docker service logs firefox ``` ### Backups -Critical data is stored in `/DockerVol/firefox`. Reconstructable data can be restored from the `firefox` stack's configuration. + +Critical data is stored in `/DockerVol/firefox`. It is critical that this volume is backed up regularly, as any loss of data will result in significant downtime and potential financial losses. ### Restore -```bash -cd services/swarm/stack/firefox -./deploy.sh -``` + +* The Docker Swarm stack must be redeployed. +* Any necessary configuration files must be recreated or copied. + +--- +title: firefox +published: true +date: 2026-04-30T14:22:18.852Z +tags: docker,swarm,firefox,netgrimoire +editor: markdown +dateCreated: 2026-04-30T14:22:18.852Z --- ## Common Failures -1. **Symptom:** Service not available. -**Cause:** Insufficient restart policy. -**Fix:** Adjust the restart policy in the stack configuration. -2. **Symptom:** Caddy not responding. -**Cause:** Incorrect Caddy configuration. -**Fix:** Review and update the Caddy labels. -3. **Symptom:** Firefox not launching. -**Cause:** Missing environment variables. -**Fix:** Ensure all required environment variables are set. -4. **Symptom:** Network connectivity issues. -**Cause:** Inconsistent network configuration. -**Fix:** Review and update the netgrimoire network configuration. -5. **Symptom:** Service not responding to monitor requests. -**Cause:** Monitor URL not correctly set. -**Fix:** Update the monitor URL in the stack configuration. + +| Failure Mode | Symptom | Cause | Fix | +|-------------|---------|------|-----| +| Firefox Not Responding | No response from the Firefox browser. | Insufficient resources. | Increase CPU or increase memory allocation. | +| Connection Refused | The connection to the Firefox server is refused. | Network issues or the Docker Swarm service is down. | Restart the Docker Swarm service and check for network connectivity. | +| Authentication Failed | The authentication credentials are not accepted by the Firefox browser. | Incorrect login credentials or a corrupted configuration file. | Check the login credentials, update any corruption to the configuration file, and try again. | + +--- +title: firefox +published: true +date: 2026-04-30T14:22:18.852Z +tags: docker,swarm,firefox,netgrimoire +editor: markdown +dateCreated: 2026-04-30T14:22:18.852Z --- @@ -105,15 +176,25 @@ cd services/swarm/stack/firefox | Date | Commit | Summary | |------|--------|---------| -| 2026-04-30 | ec464fcf | Initial documentation | -| 2026-04-30 | d3f33ca8 | Updated Caddy labels | -| 2026-04-30 | f96d934c | Added POODLE disable env var | -| 2026-04-30 | fd71b433 | Fixed restart policy issue | -| 2026-04-30 | 9aff6495 | Updated monitor URL | +| 2026-04-30 | 6a8e5d40 | Firefox stack updated with new configuration and bug fixes. | +| 2026-04-30 | ec464fcf | Fixed issue with the Docker Swarm service being unable to connect to the Firefox server. | +| 2026-04-30 | d3f33ca8 | Added logging for the Firefox browser's activity when using the remote control. | +| 2026-04-30 | f96d934c | Updated the Firefox stack with a new version of the Docker image that includes bug fixes and performance improvements. | +| 2026-04-30 | fd71b433 | Fixed issue with the configuration file not being properly copied during deployment. | +| 2026-04-30 | ac4c67cf | Added logging for errors in the Firefox browser when using the remote control. | + +--- +title: firefox +published: true +date: 2026-04-30T14:22:18.852Z +tags: docker,swarm,firefox,netgrimoire +editor: markdown +dateCreated: 2026-04-30T14:22:18.852Z --- ## Notes -- Generated by Gremlin on 2026-04-30T14:20:47.646Z -- Source: swarm/firefox.yaml -- Review User Guide and Changelog sections \ No newline at end of file + +* Generated by Gremlin on 2026-04-30T14:22:18.852Z +* Source: swarm/firefox.yaml +* Review User Guide and Changelog sections \ No newline at end of file