docs(gremlin): update firefox
This commit is contained in:
parent
e91f8f7113
commit
72052b9b2b
1 changed files with 29 additions and 33 deletions
|
|
@ -1,24 +1,25 @@
|
|||
---
|
||||
title: firefox Stack
|
||||
description: Firefox remote browser stack in NetGrimoire
|
||||
description: Remote Browser
|
||||
published: true
|
||||
date: 2026-04-30T18:31:08.272Z
|
||||
date: 2026-05-01T02:40:45.857Z
|
||||
tags: docker,swarm,firefox,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-30T18:31:08.272Z
|
||||
dateCreated: 2026-05-01T02:40:45.857Z
|
||||
---
|
||||
|
||||
# firefox
|
||||
|
||||
## 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
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** firefox.netgrimoire.com, 5800:5800
|
||||
- **Exposed via:** firefox.netgrimoire.com
|
||||
- **Homepage group:** Remote Access
|
||||
|
||||
---
|
||||
|
|
@ -26,20 +27,21 @@ The `firefox` stack in NetGrimoire provides a remote browser service using the F
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites are required for this stack.
|
||||
No specific prerequisites for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/firefox
|
||||
chown -R docker4:dockerrun:/DockerVol/firefox
|
||||
chown -R user:group /DockerVol/firefox
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
|
||||
generate: openssl rand -hex 32
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
|
@ -53,7 +55,7 @@ docker stack services firefox
|
|||
```
|
||||
|
||||
### 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
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **Caddy:** http://firefox:5800
|
||||
- **Uptime Kuma:** http://firefox:5900
|
||||
- **Monitoring:** http://firefox:5800
|
||||
- **Dashboard:** https://firefox.netgrimoire.com
|
||||
- **URL:** http://firefox:5800
|
||||
- **Purpose:** Remote access to the Firefox browser instance
|
||||
|
||||
### 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
|
||||
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
|
||||
```bash
|
||||
docker stack services firefox
|
||||
docker service logs firefox -f
|
||||
<docker service logs commands>
|
||||
```
|
||||
|
||||
### 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
|
||||
To restore the service, run `./deploy.sh`.
|
||||
```bash
|
||||
cd services/swarm/stack/firefox
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
|
||||
| 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 |
|
||||
|---------|------|-----|
|
||||
- No response from the Firefox browser instance | Incorrect Docker stack configuration | Check `docker stack config` output and correct it.
|
||||
- Firefox browser instance is not accessible via Caddy | Caddy is not running correctly | Check Caddy logs for errors and restart it if necessary.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -104,15 +107,8 @@ To restore the service, run `./deploy.sh`.
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 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 |
|
||||
- 2026-04-30 | f96d934c | Initial documentation created. |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-30T18:31:08.272Z
|
||||
- Source: swarm/firefox.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Generated by Gremlin on 2026-05-01T02:40:45.857Z
|
||||
Source: swarm/firefox.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue