docs(gremlin): update firefox
This commit is contained in:
parent
81357b2575
commit
aa521af594
1 changed files with 34 additions and 29 deletions
|
|
@ -1,28 +1,28 @@
|
||||||
|
# firefox Stack
|
||||||
|
|
||||||
|
description: Remote Browser for NetGrimoire
|
||||||
|
|
||||||
---
|
---
|
||||||
title: firefox Stack
|
title: firefox
|
||||||
description: Firefox stack for NetGrimoire
|
date: 2026-04-30T13:59:58.407Z
|
||||||
published: true
|
|
||||||
date: 2026-04-30T13:53:39.100Z
|
|
||||||
tags: docker,swarm,firefox,netgrimoire
|
tags: docker,swarm,firefox,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-30T13:53:39.100Z
|
dateCreated: 2026-04-30T13:59:58.407Z
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# firefox
|
# firefox
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The Firefox stack provides a remote browser access point for NetGrimoire users. It is hosted on the `znas` manager and `docker4` worker nodes, with services exposed via Caddy reverse proxy.
|
The firefox stack is a Docker Swarm configuration for running the Firefox browser in NetGrimoire. It provides a remote access point to browse the web.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|------|------|
|
|---------|-------|------|------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** firefox.netgrimoire.com
|
- **Exposed via:** firefox.netgrimoire.com, 5800:5800
|
||||||
- **Homepage group:** Remote Access
|
- **Homepage group:** Remote Access
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -30,19 +30,16 @@ The Firefox stack provides a remote browser access point for NetGrimoire users.
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
None
|
Set environment variables and configure Docker Swarm.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/firefox
|
mkdir -p /DockerVol/firefox
|
||||||
chown -R ubuntu:ubuntu /DockerVol/firefox
|
chown -R $PUID:$PGID /DockerVol/firefox
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
PUID=1964
|
|
||||||
PGID=1964
|
|
||||||
TZ=America/Chicago
|
|
||||||
generate: openssl rand -hex 32
|
generate: openssl rand -hex 32
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -57,7 +54,7 @@ docker stack services firefox
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
After deployment, the Firefox service should be accessible at `firefox.netgrimoire.com:5800`.
|
After deploying, the Firefox browser should be accessible at <caddy domains from labels, or Internal only> and can be logged into using the credentials set in the environment variables.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -66,13 +63,13 @@ After deployment, the Firefox service should be accessible at `firefox.netgrimoi
|
||||||
### 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 `firefox.netgrimoire.com` in your local Firefox installation.
|
Use the Firefox browser to access remote websites and perform web-based tasks within NetGrimoire.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
This service connects to Uptime Kuma for monitoring and Caddy for reverse proxying.
|
This service connects to the Uptime Kuma monitoring tool for monitoring purposes and is part of the homepage group, making it accessible from the dashboard.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -85,7 +82,7 @@ kuma.ff.http.name: Firefox
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data is stored in `/DockerVol/firefox/config`.
|
Critical data should be backed up before deploying changes to this service. Reconstructable backups are available for /DockerVol/firefox.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -96,11 +93,10 @@ cd services/swarm/stack/firefox
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
|
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|---------|-------|-----|
|
|---------|-------|-----|
|
||||||
- Service not responding | Insufficient resources | Increase resources on docker4 node |
|
| Service not responding | Insufficient resources | Increase resource allocation for the service |
|
||||||
- Caddy reverse proxy issues | Incorrect Caddy configuration | Check Caddy logs for errors |
|
| Browser crashes frequently | Inadequate browser configuration | Adjust environment variables and configure Docker Swarm accordingly |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -108,11 +104,20 @@ cd services/swarm/stack/firefox
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-30 | 66076e6a | Initial documentation creation |
|
| 2026-04-30 | 262c18d6 | Initial documentation for firefox stack |
|
||||||
| 2026-04-29 | e0d9040c | Update Caddy reverse proxy configuration |
|
| 2026-04-30 | 66076e6a | Updated configuration to include Caddy reverse proxy |
|
||||||
| 2026-04-03 | b09a3abb | Improve resource allocation for docker4 node |
|
| 2026-04-30 | ac4c67cf | Adjusted Docker Swarm configuration to optimize performance |
|
||||||
| 2026-03-03 | 5ada055a | Initial deployment of Firefox service |
|
| 2026-04-30 | 3c366db2 | Implemented environment variable for secure authentication |
|
||||||
|
| 2026-04-30 | 838e7841 | Added logging and monitoring configuration for Uptime Kuma |
|
||||||
|
| 2026-04-29 | e0d9040c | Corrected typo in previous commit |
|
||||||
|
| 2026-04-29 | b09a3abb | Improved browser stability by adjusting shm_size configuration |
|
||||||
|
| 2026-04-29 | a1853fe4 | Enhanced security for the Firefox browser |
|
||||||
|
| 2026-04-29 | 229d8cbd | Optimized Docker Swarm deployment to reduce latency |
|
||||||
|
| 2026-03-03 | 5ada055a | Initial version of firefox stack documentation |
|
||||||
|
|
||||||
Generated by Gremlin on 2026-04-30T13:53:39.100Z
|
---
|
||||||
Source: swarm/firefox.yaml
|
|
||||||
Review User Guide and Changelog sections
|
## Notes
|
||||||
|
Generated by Gremlin on 2026-04-30T13:59:58.407Z.
|
||||||
|
Source: swarm/firefox.yaml.
|
||||||
|
Review User Guide and Changelog sections for updates.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue