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 21:41:43 -05:00
parent e91f8f7113
commit 72052b9b2b
1 changed files with 29 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,24 +1,25 @@
--- ---
title: firefox Stack title: firefox Stack
description: Firefox remote browser stack in NetGrimoire description: Remote Browser
published: true published: true
date: 2026-04-30T18:31:08.272Z date: 2026-05-01T02:40:45.857Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T18:31:08.272Z dateCreated: 2026-05-01T02:40:45.857Z
--- ---
# firefox # firefox
## Overview ## Overview
The `firefox` stack in NetGrimoire provides a remote browser service using the Firefox web browser. The firefox stack in NetGrimoire provides a remote access to a browser instance running on Firefox. It utilizes Docker Swarm for orchestration and Caddy as the reverse proxy.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** firefox.netgrimoire.com, 5800:5800 - **Exposed via:** firefox.netgrimoire.com
- **Homepage group:** Remote Access - **Homepage group:** Remote Access
--- ---
@ -26,20 +27,21 @@ The `firefox` stack in NetGrimoire provides a remote browser service using the F
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. No specific prerequisites for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R docker4:dockerrun:/DockerVol/firefox chown -R user:group /DockerVol/firefox
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago TZ=America/Chicago
generate: openssl rand -hex 32
``` ```
### Deploy ### Deploy
@ -53,7 +55,7 @@ docker stack services firefox
``` ```
### First Run ### First Run
No specific post-deploy steps are required for this service. No specific post-deploy steps are required.
--- ---
@ -62,16 +64,14 @@ No specific post-deploy steps are required for this service.
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Caddy:** http://firefox:5800 - **URL:** http://firefox:5800
- **Uptime Kuma:** http://firefox:5900 - **Purpose:** Remote access to the Firefox browser instance
- **Monitoring:** http://firefox:5800
- **Dashboard:** https://firefox.netgrimoire.com
### Primary Use Cases ### Primary Use Cases
To access the remote browser, navigate to `https://firefox.netgrimoire.com` in your web browser. To use this stack in NetGrimoire, navigate to `http://firefox.netgrimoire.com` and start a new session.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to Authentik and CrowdSec. This service connects to other services via environment variables and labels.
--- ---
@ -80,23 +80,26 @@ This service connects to Authentik and CrowdSec.
### Monitoring ### Monitoring
```bash ```bash
docker stack services firefox docker stack services firefox
docker service logs firefox -f <docker service logs commands>
``` ```
### Backups ### Backups
Critical data should be backed up before making any changes to this service. The `/DockerVol/firefox` volume is used for storing configuration files. Critical vs reconstructable /DockerVol/firefox paths. Store backups on a secure location.
### Restore ### Restore
To restore the service, run `./deploy.sh`. ```bash
cd services/swarm/stack/firefox
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|------|-----|
- Browser crashes frequently | Insufficient resources | Increase resources or optimize browser settings | - No response from the Firefox browser instance | Incorrect Docker stack configuration | Check `docker stack config` output and correct it.
- Firefox login fails | Incorrect credentials | Verify credentials in .env file | - Firefox browser instance is not accessible via Caddy | Caddy is not running correctly | Check Caddy logs for errors and restart it if necessary.
- Service does not start | Incorrect Docker stack configuration | Review `firefox-stack.yml` and correct any errors |
--- ---
@ -104,15 +107,8 @@ To restore the service, run `./deploy.sh`.
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 0dd852b5 | Initial deployment of firefox stack | - 2026-04-30 | f96d934c | Initial documentation created. |
| 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 |
--- Generated by Gremlin on 2026-05-01T02:40:45.857Z
Source: swarm/firefox.yaml
## Notes Review User Guide and Changelog sections
- Generated by Gremlin on 2026-04-30T18:31:08.272Z
- Source: swarm/firefox.yaml
- Review User Guide and Changelog sections