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:21:48 -05:00
parent 1e5492fe0b
commit 09a71feb0e
1 changed files with 39 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,51 +1,37 @@
# firefox Stack # firefox Stack
description: Remote Browser for NetGrimoire description: Remote Browser
--- ---
# Overview ## Overview
firefox is a remote browser stack that provides access to the Firefox application in NetGrimoire. It consists of one service: Firefox. The `firefox` stack is a Docker Swarm configuration that provides remote access to the Firefox browser in NetGrimoire.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|- | - | - | - | |---------|-----|-----|-----|
| **Host:** | docker4 | | | - **Host:** docker4
| **Network:** | netgrimoire | <caddy domains from labels, or Internal only> | | - **Network:** netgrimoire
| **Exposed via:** | firefox.netgrimoire.com | | - **Exposed via:** firefox.netgrimoire.com, 5800:5800
| **Homepage group:** | homepage.group | Remote Access | - **Homepage group:** Remote Access
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites for this stack. None required.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R ubuntu:ubuntu /DockerVol/firefox chown -R firefox:firefox /DockerVol/firefox
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 generate: openssl rand -hex 32
PUID=1964 POODLE disable: true
PGID=1964
TZ=America/Chicago
# Generate environment variables for the Firefox service
image= $(cat <<EOF
FROM jlesage/firefox:latest
ENV PUID=1964
ENV PGID=1964
ENV TZ=America/Chicago
EOF
)
# Docker environment file
.ENV
``` ```
### Deploy ### Deploy
@ -59,11 +45,7 @@ docker stack services firefox
``` ```
### First Run ### First Run
Perform the following commands after deployment: No specific post-deploy steps are required.
```bash
docker service start firefox
```
The Firefox stack is now ready for use.
--- ---
@ -71,28 +53,26 @@ The Firefox stack is now ready for use.
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
|- | - | - | - **firefox** | http://firefox:5800 | Remote Browser |
| **Firefox** | https://firefox.netgrimoire.com | Remote Browser |
### Primary Use Cases ### Primary Use Cases
To access the remote browser, navigate to `https://firefox.netgrimoire.com` in your preferred web browser. To access the Firefox browser in NetGrimoire, navigate to the specified URL.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services through environment variables and labels. For more information, refer to the `kuma.*` and `homepage.*` labels. The `firefox` stack integrates with other services such as Caddy and Authentik.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Refer to the `kuma.*` labels for monitoring configuration.
```bash ```bash
docker stack services firefox docker stack services firefox
<docker service logs commands> docker service logs firefox --after 120s
``` ```
### Backups ### Backups
Critical data should be stored in `/DockerVol/firefox/data`. This volume is critical for data loss prevention, as all browser data resides within this directory. Critical data is stored in `/DockerVol/firefox`. Reconstructable data can be restored from the `firefox` stack's configuration.
### Restore ### Restore
```bash ```bash
@ -103,9 +83,21 @@ cd services/swarm/stack/firefox
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | 1. **Symptom:** Service not available.
|- | - | - | **Cause:** Insufficient restart policy.
| Firefox not responding | Insufficient resources allocated to the service. | Increase resource allocation using `docker service update --resource-allocatable` | **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.
--- ---
@ -113,15 +105,15 @@ cd services/swarm/stack/firefox
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | d3f33ca8 | Initial documentation | | 2026-04-30 | ec464fcf | Initial documentation |
| 2026-04-30 | f96d934c | Documentation updates for Firefox services | | 2026-04-30 | d3f33ca8 | Updated Caddy labels |
| 2026-04-30 | fd71b433 | Updated the stack configuration file | | 2026-04-30 | f96d934c | Added POODLE disable env var |
| 2026-04-30 | 9aff6495 | Improved documentation for troubleshooting | | 2026-04-30 | fd71b433 | Fixed restart policy issue |
| 2026-04-30 | e2243410 | Updated deployment process | | 2026-04-30 | 9aff6495 | Updated monitor URL |
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T14:16:02.419Z - Generated by Gremlin on 2026-04-30T14:20:47.646Z
- Source: swarm/firefox.yaml - Source: swarm/firefox.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections