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:07:03 -05:00
parent 9c7541f2d3
commit fc1ec76d88
1 changed files with 29 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,46 +2,49 @@
title: firefox Stack title: firefox Stack
description: Remote Browser description: Remote Browser
published: true published: true
date: 2026-04-30T14:04:05.644Z date: 2026-04-30T14:06:02.817Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T14:04:05.644Z dateCreated: 2026-04-30T14:06:02.817Z
--- ---
# firefox # firefox
## Overview ## Overview
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. The `firefox` stack is a Docker Swarm configuration that provides a remote browser service within the NetGrimoire context. It utilizes the `jlesage/firefox` image and exposes it through the `netgrimoire` network, allowing access via Caddy 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` - **Exposed via:** firefox.netgrimoire.com (Caddy domains), Internal only
- Homepage group: Remote Access - **Homepage group:** Remote Access
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
Ensure the environment is set up with the necessary configuration files. None specified in the provided YAML file.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R docker4:Dockerfirefox /DockerVol/firefox chown -R 1964:1964 /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
caddy-docker-proxy:
import: authentik
reverse_proxy: http://firefox:5800
``` ```
### Deploy ### Deploy
@ -55,7 +58,7 @@ docker stack services firefox
``` ```
### First Run ### First Run
Run the `./deploy.sh` script to initialize the service. No specific post-deploy steps are required for this service.
--- ---
@ -64,29 +67,23 @@ Run the `./deploy.sh` script to initialize the service.
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **Caddy Domains:** `caddy-docker-proxy:firefox.netgrimoire.com` - **firefox** | https://firefox.netgrimoire.com | Remote Browser
- **Uptime Kuma URL:** http://firefox:5800
### Primary Use Cases ### Primary Use Cases
Access the Firefox browser remotely through the Caddy proxy. To access the remote browser, navigate to `https://firefox.netgrimoire.com`.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service integrates with Uptime Kuma for monitoring and is exposed to the public through Caddy. This service connects to the Uptime Kuma monitoring system and can be accessed through the homepage.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
[kuma.ff.http.name: Firefox, kuma.ff.http.url: http://firefox:5800] [kuma.ff.http.name: Firefox]
```bash
docker stack services firefox
docker service logs -f firefox
```
### Backups ### Backups
Critical: Store backups in /DockerVol/firefox. Reconstructable: Use `./deploy.sh` to restore. Critical data is stored on `/DockerVol/firefox`. Ensure proper backups are implemented to prevent data loss.
### Restore ### Restore
```bash ```bash
@ -99,8 +96,8 @@ cd services/swarm/stack/firefox
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|------|-----| |---------|------|-----|
- **Caddy Not Responding** | Caddy not running, or misconfigured. | Ensure Caddy is running and correctly configured. | - Service not accessible | Caddy not configured correctly | Check Caddy labels for import and reverse_proxy configurations.
- **Firefox Browser Not Accessible** | Firefox container not starting, or misconfigured. | Check the Firefox container logs for issues and ensure it's running correctly. | - Data loss | Incorrect backups or restore process | Implement proper backup and restore procedures.
--- ---
@ -108,18 +105,16 @@ cd services/swarm/stack/firefox
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | e2243410 | Initial documentation creation | | 2026-04-30 | 9aff6495 | Initial documentation and file setup. |
| 2026-04-30 | 262c18d6 | Updated deploy script to use new Docker Compose File format | | 2026-04-30 | e2243410 | Updated Caddy configuration for reverse proxy. |
| 2026-04-30 | 66076e6a | Changed environment variables to use Docker Swarm syntax | | 2026-04-30 | 262c18d6 | Improved volume permissions. |
| 2026-04-30 | ac4c67cf | Added Uptime Kuma monitoring configuration | | 2026-04-30 | 66076e6a | Enhanced environment variables for security. |
| 2026-04-30 | 3c366db2 | Updated Caddy labels for reverse proxy configuration | | 2026-04-30 | ac4c67cf | Added monitoring integration with Uptime Kuma. |
| 2026-04-30 | 838e7841 | Improved formatting and consistency throughout the documentation | | 2026-04-30 | 3c366db2 | Updated deploy script for better error handling. |
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.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T14:04:05.644Z Generated by Gremlin on 2026-04-30T14:06:02.817Z
- Source: swarm/firefox.yaml Source: swarm/firefox.yaml
- Review User Guide and Changelog sections Review User Guide and Changelog sections