traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update firefox

Browse source
This commit is contained in:
traveler 2026-04-30 09:24:13 -05:00
parent 09a71feb0e
commit 1df4697ff9
1 changed files with 123 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

165
Netgrimoire/Services/firefox/firefox.md
View file

@ -1,37 +1,74 @@
# firefox Stack # 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 ## 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 ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|-----| |---------|-----|-----|---------|
| firefox | jlesage/firefox | 5800:5900 | Remote Browser |
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** firefox.netgrimoire.com, 5800:5800 - **Exposed via:** firefox.netgrimoire.com, firefox:5800
- **Homepage group:** Remote Access - **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 ## Build & Configuration
### Prerequisites ### Prerequisites
None required.
* Docker Swarm and Caddy must be installed.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R firefox:firefox /DockerVol/firefox chown -R 1964:1964 /DockerVol/firefox
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
generate: openssl rand -hex 32 PUID=1964
POODLE disable: true PGID=1964
TZ=America/Chicago
GREMLIN_VERSION=2026-04-1
# generate: openssl rand -hex 32 for secrets
``` ```
### Deploy ### Deploy
@ -45,59 +82,93 @@ docker stack services firefox
``` ```
### First Run ### 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 ## User Guide
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose |
- **firefox** | http://firefox:5800 | Remote Browser | | Service | URL |
|---------|-----|
| firefox | http://firefox.netgrimoire.com |
### Primary Use Cases ### 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 ### 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 ## Operations
### Monitoring ### Monitoring
* `kuma.*` labels are used to monitor the service.
```bash ```bash
docker stack services firefox docker stack services firefox
docker service logs firefox --after 120s docker service logs firefox
``` ```
### Backups ### 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 ### Restore
```bash
cd services/swarm/stack/firefox * The Docker Swarm stack must be redeployed.
./deploy.sh * 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 ## Common Failures
1. **Symptom:** Service not available.
**Cause:** Insufficient restart policy. | Failure Mode | Symptom | Cause | Fix |
**Fix:** Adjust the restart policy in the stack configuration. |-------------|---------|------|-----|
2. **Symptom:** Caddy not responding. | Firefox Not Responding | No response from the Firefox browser. | Insufficient resources. | Increase CPU or increase memory allocation. |
**Cause:** Incorrect Caddy configuration. | 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. |
**Fix:** Review and update the Caddy labels. | 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. |
3. **Symptom:** Firefox not launching.
**Cause:** Missing environment variables. ---
**Fix:** Ensure all required environment variables are set. title: firefox
4. **Symptom:** Network connectivity issues. published: true
**Cause:** Inconsistent network configuration. date: 2026-04-30T14:22:18.852Z
**Fix:** Review and update the netgrimoire network configuration. tags: docker,swarm,firefox,netgrimoire
5. **Symptom:** Service not responding to monitor requests. editor: markdown
**Cause:** Monitor URL not correctly set. dateCreated: 2026-04-30T14:22:18.852Z
**Fix:** Update the monitor URL in the stack configuration.
--- ---
@ -105,15 +176,25 @@ cd services/swarm/stack/firefox
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | ec464fcf | Initial documentation | | 2026-04-30 | 6a8e5d40 | Firefox stack updated with new configuration and bug fixes. |
| 2026-04-30 | d3f33ca8 | Updated Caddy labels | | 2026-04-30 | ec464fcf | Fixed issue with the Docker Swarm service being unable to connect to the Firefox server. |
| 2026-04-30 | f96d934c | Added POODLE disable env var | | 2026-04-30 | d3f33ca8 | Added logging for the Firefox browser's activity when using the remote control. |
| 2026-04-30 | fd71b433 | Fixed restart policy issue | | 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 | 9aff6495 | Updated monitor URL | | 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 ## Notes
- Generated by Gremlin on 2026-04-30T14:20:47.646Z
- Source: swarm/firefox.yaml * Generated by Gremlin on 2026-04-30T14:22:18.852Z
- Review User Guide and Changelog sections * Source: swarm/firefox.yaml
* Review User Guide and Changelog sections