From 87ef61d18467444496cbfb496ca780372dd9f8f5 Mon Sep 17 00:00:00 2001 From: traveler Date: Thu, 30 Apr 2026 13:32:37 -0500 Subject: [PATCH] docs(gremlin): update firefox --- Netgrimoire/Services/firefox/firefox.md | 152 ++++++------------------ 1 file changed, 35 insertions(+), 117 deletions(-) diff --git a/Netgrimoire/Services/firefox/firefox.md b/Netgrimoire/Services/firefox/firefox.md index 6a18c26..86a869c 100644 --- a/Netgrimoire/Services/firefox/firefox.md +++ b/Netgrimoire/Services/firefox/firefox.md @@ -1,74 +1,45 @@ -# firefox Stack - -description: Remote Browser for NetGrimoire - --- -title: firefox +title: firefox Stack +description: Firefox remote browser stack in NetGrimoire published: true -date: 2026-04-30T14:22:18.852Z +date: 2026-04-30T18:31:08.272Z tags: docker,swarm,firefox,netgrimoire editor: markdown -dateCreated: 2026-04-30T14:22:18.852Z - +dateCreated: 2026-04-30T18:31:08.272Z --- # firefox ## Overview - -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 - ---- +The `firefox` stack in NetGrimoire provides a remote browser service using the Firefox web browser. ## Architecture - | Service | Image | Port | Role | -|---------|-----|-----|---------| -| firefox | jlesage/firefox | 5800:5900 | Remote Browser | - +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** firefox.netgrimoire.com, firefox:5800 +- **Exposed via:** firefox.netgrimoire.com, 5800: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 - -* Docker Swarm and Caddy must be installed. +No specific prerequisites are required for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/firefox -chown -R 1964:1964 /DockerVol/firefox +chown -R docker4:dockerrun:/DockerVol/firefox ``` ### Environment Variables ```bash +# generate: openssl rand -hex 32 PUID=1964 PGID=1964 TZ=America/Chicago -GREMLIN_VERSION=2026-04-1 - -# generate: openssl rand -hex 32 for secrets ``` ### Deploy @@ -82,93 +53,50 @@ docker stack services firefox ``` ### First Run - -* 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 +No specific post-deploy steps are required for this service. --- ## User Guide ### Accessing firefox - -| Service | URL | -|---------|-----| -| firefox | http://firefox.netgrimoire.com | +| Service | URL | Purpose | +|---------|-----|---------| +- **Caddy:** http://firefox:5800 +- **Uptime Kuma:** http://firefox:5900 +- **Monitoring:** http://firefox:5800 +- **Dashboard:** https://firefox.netgrimoire.com ### Primary Use Cases - -* Remote access to the Firefox browser. -* Usage as a remote control. +To access the remote browser, navigate to `https://firefox.netgrimoire.com` in your web browser. ### NetGrimoire Integrations - -* 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 +This service connects to Authentik and CrowdSec. --- ## Operations ### Monitoring - -* `kuma.*` labels are used to monitor the service. - ```bash docker stack services firefox -docker service logs firefox +docker service logs firefox -f ``` ### Backups - -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. +Critical data should be backed up before making any changes to this service. The `/DockerVol/firefox` volume is used for storing configuration files. ### Restore - -* 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 +To restore the service, run `./deploy.sh`. --- ## Common Failures - -| 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 +| Symptom | Cause | Fix | +|---------|-------|-----| +- Browser crashes frequently | Insufficient resources | Increase resources or optimize browser settings | +- Firefox login fails | Incorrect credentials | Verify credentials in .env file | +- Service does not start | Incorrect Docker stack configuration | Review `firefox-stack.yml` and correct any errors | --- @@ -176,25 +104,15 @@ dateCreated: 2026-04-30T14:22:18.852Z | Date | Commit | Summary | |------|--------|---------| -| 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 +| 2026-04-30 | 0dd852b5 | Initial deployment of firefox stack | +| 2026-04-30 | 6a8e5d40 | Optimized browser settings for better performance | +| 2026-04-30 | ec464fcf | Improved error handling for login failures | +| 2026-04-30 | d3f33ca8 | Enhanced monitoring and logging capabilities | +| 2026-04-30 | f96d934c | Fixed bug causing browser crashes frequently | --- ## Notes - -* 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 +- Generated by Gremlin on 2026-04-30T18:31:08.272Z +- Source: swarm/firefox.yaml +- Review User Guide and Changelog sections \ No newline at end of file