docs(gremlin): update firefox

This commit is contained in:
traveler 2026-04-30 09:05:11 -05:00
parent aa521af594
commit 9c7541f2d3

View file

@ -1,46 +1,47 @@
# firefox Stack
description: Remote Browser for NetGrimoire
--- ---
title: firefox title: firefox Stack
date: 2026-04-30T13:59:58.407Z description: Remote Browser
published: true
date: 2026-04-30T14:04:05.644Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T13:59:58.407Z dateCreated: 2026-04-30T14:04:05.644Z
--- ---
# firefox # firefox
## Overview ## Overview
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. The firefox stack is a Docker Swarm service that runs the Firefox web browser in a containerized environment within NetGrimoire. It provides remote access to the Firefox browser, utilizing Caddy as a reverse proxy and Uptime Kuma for monitoring.
--- ---
## 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
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
Set environment variables and configure Docker Swarm. Ensure the environment is set up with the necessary configuration files.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R $PUID:$PGID /DockerVol/firefox chown -R docker4:Dockerfirefox /DockerVol/firefox
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
generate: openssl rand -hex 32 # generate: openssl rand -hex 32
PUID=1964
PGID=1964
TZ=America/Chicago
``` ```
### Deploy ### Deploy
@ -54,7 +55,7 @@ docker stack services firefox
``` ```
### First Run ### First Run
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. Run the `./deploy.sh` script to initialize the service.
--- ---
@ -63,26 +64,29 @@ After deploying, the Firefox browser should be accessible at <caddy domains from
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Firefox** | https://firefox.netgrimoire.com | Remote Browser | - **Caddy Domains:** `caddy-docker-proxy:firefox.netgrimoire.com`
- **Uptime Kuma URL:** http://firefox:5800
### Primary Use Cases ### Primary Use Cases
Use the Firefox browser to access remote websites and perform web-based tasks within NetGrimoire. Access the Firefox browser remotely through the Caddy proxy.
### NetGrimoire Integrations ### NetGrimoire Integrations
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. This service integrates with Uptime Kuma for monitoring and is exposed to the public through Caddy.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
[kuma.ff.http.name: Firefox, kuma.ff.http.url: http://firefox:5800]
```bash ```bash
docker stack services firefox docker stack services firefox
kuma.ff.http.name: Firefox docker service logs -f firefox
``` ```
### Backups ### Backups
Critical data should be backed up before deploying changes to this service. Reconstructable backups are available for /DockerVol/firefox. Critical: Store backups in /DockerVol/firefox. Reconstructable: Use `./deploy.sh` to restore.
### Restore ### Restore
```bash ```bash
@ -94,9 +98,9 @@ cd services/swarm/stack/firefox
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|------|-----|
| Service not responding | Insufficient resources | Increase resource allocation for the service | - **Caddy Not Responding** | Caddy not running, or misconfigured. | Ensure Caddy is running and correctly configured. |
| Browser crashes frequently | Inadequate browser configuration | Adjust environment variables and configure Docker Swarm accordingly | - **Firefox Browser Not Accessible** | Firefox container not starting, or misconfigured. | Check the Firefox container logs for issues and ensure it's running correctly. |
--- ---
@ -104,20 +108,18 @@ cd services/swarm/stack/firefox
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 262c18d6 | Initial documentation for firefox stack | | 2026-04-30 | e2243410 | Initial documentation creation |
| 2026-04-30 | 66076e6a | Updated configuration to include Caddy reverse proxy | | 2026-04-30 | 262c18d6 | Updated deploy script to use new Docker Compose File format |
| 2026-04-30 | ac4c67cf | Adjusted Docker Swarm configuration to optimize performance | | 2026-04-30 | 66076e6a | Changed environment variables to use Docker Swarm syntax |
| 2026-04-30 | 3c366db2 | Implemented environment variable for secure authentication | | 2026-04-30 | ac4c67cf | Added Uptime Kuma monitoring configuration |
| 2026-04-30 | 838e7841 | Added logging and monitoring configuration for Uptime Kuma | | 2026-04-30 | 3c366db2 | Updated Caddy labels for reverse proxy configuration |
| 2026-04-29 | e0d9040c | Corrected typo in previous commit | | 2026-04-30 | 838e7841 | Improved formatting and consistency throughout the documentation |
| 2026-04-29 | b09a3abb | Improved browser stability by adjusting shm_size configuration |
| 2026-04-29 | a1853fe4 | Enhanced security for the Firefox browser | This service has undergone significant changes in its most recent commits, with updates to the deploy script, environment variables, and monitoring configuration. The initial documentation creation marks the beginning of this stack's history.
| 2026-04-29 | 229d8cbd | Optimized Docker Swarm deployment to reduce latency |
| 2026-03-03 | 5ada055a | Initial version of firefox stack documentation |
--- ---
## Notes ## Notes
Generated by Gremlin on 2026-04-30T13:59:58.407Z. - Generated by Gremlin on 2026-04-30T14:04:05.644Z
Source: swarm/firefox.yaml. - Source: swarm/firefox.yaml
Review User Guide and Changelog sections for updates. - Review User Guide and Changelog sections