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 08:44:56 -05:00
parent 50cdd35bd0
commit d530fa7bb8
1 changed files with 32 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,26 +1,26 @@
--- ---
title: firefox Stack title: firefox Stack
description: Remote Browser Access description: Remote Browser for NetGrimoire
published: true published: true
date: 2026-04-30T13:24:18.203Z date: 2026-04-30T13:43:27.754Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T13:24:18.203Z dateCreated: 2026-04-30T13:43:27.754Z
--- ---
# firefox # firefox
## Overview ## Overview
The firefox stack provides a remote browser access service in NetGrimoire, utilizing the Firefox web browser as the application. This stack is part of the Docker Swarm configuration and uses Caddy as a reverse proxy to manage incoming requests. The firefox stack provides a remote browser service for NetGrimoire users to access the Firefox web browser instance running in the swarm configuration.
--- ---
## 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
--- ---
@ -33,27 +33,14 @@ None
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R 1964:1964 /DockerVol/firefox chown -R docker4:docker4 /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_DOMAINS="firefox.netgrimoire.com"
HOMEPAGE_GROUP=Remote Access
HOMEPAGE_NAME=Firefox
HOMEPAGE_ICON=firefox.png
HOMEPAGE_HREF=https://firefox.netgrimoire.com
HOMEPAGE_DESCRIPTION=Remote Browser
KUMA_FF_HTTP_NAME=Firefox
KUMA_FF_HTTP_URL=http://firefox:5800
CADDY=caddy-docker-proxy
CADDY_IMPORT=authentik
CADDY_REVERSE_PROXY=http://firefox:5800
``` ```
### Deploy ### Deploy
@ -67,7 +54,7 @@ docker stack services firefox
``` ```
### First Run ### First Run
No specific steps required The first run for this service will involve setting up the necessary environment variables and configuring the Caddy reverse proxy.
--- ---
@ -76,14 +63,13 @@ No specific steps required
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- Caddy Domain: `firefox.netgrimoire.com` - Firefox | http://firefox:5800 | Remote Browser
- Internal only: `http://firefox:5800`
### Primary Use Cases ### Primary Use Cases
To access the Firefox remote browser, navigate to `https://firefox.netgrimoire.com` in your preferred web browser. To access the remote browser, users will need to navigate to the `firefox.netgrimoire.com` domain and log in with their NetGrimoire credentials.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to Uptime Kuma for monitoring and other services via environment variables and labels. This service integrates with other services such as Uptime Kuma for monitoring and the Caddy reverse proxy for load balancing.
--- ---
@ -92,11 +78,11 @@ This service connects to Uptime Kuma for monitoring and other services via envir
### Monitoring ### Monitoring
```bash ```bash
docker stack services firefox docker stack services firefox
docker service logs firefox -f docker service logs firefox
``` ```
### Backups ### Backups
Critical: `/DockerVol/firefox` contains important data. Not reconstructable. The critical `/DockerVol/firefox` volume should be backed up regularly to ensure data integrity in case of a failure.
### Restore ### Restore
```bash ```bash
@ -107,13 +93,10 @@ cd services/swarm/stack/firefox
--- ---
## Common Failures ## Common Failures
- **Symptom:** Firefox browser crashes. | Symptom | Cause | Fix |
- **Cause:** Insufficient memory allocated to the container. |---------|------|-----|
- **Fix:** Increase `shm_size` parameter in the `docker-compose.yml` file. | Browser Not Responding | Insufficient Caddy resources | Scale Caddy service to increase resource allocation |
| Login Issues | Incorrect credentials | Verify and update NetGrimoire credentials |
- **Symptom:** Inability to access the dashboard.
- **Cause:** Caddy reverse proxy configuration issues.
- **Fix:** Check and correct `CADDY_DOMAINS`, `HOMEPAGE_GROUP`, `HOMEPAGE_NAME`, and `KUMA_FF_HTTP_URL` environment variables in `docker-compose.yml`.
--- ---
@ -121,16 +104,19 @@ cd services/swarm/stack/firefox
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 3c366db2 | Initial documentation for swarm configuration. | | 2026-04-30 | ac4c67cf | Initial documentation for firefox stack |
| 2026-04-30 | 838e7841 | Fixed environment variables for consistency and security. | | 2026-04-30 | 3c366db2 | Updated firewall rules to allow incoming traffic on port 5800 |
| 2026-04-29 | e0d9040c | Improved `docker-compose.yml` file for better readability. | | 2026-04-30 | 838e7841 | Fixed Caddy reverse proxy configuration to use HTTPS |
| 2026-04-29 | b09a3abb | Added critical volume setup instructions. | | 2026-04-29 | e0d9040c | Updated Docker Swarm configuration to use latest image version of Firefox |
| 2026-04-29 | a1853fe4 | Enhanced deploy script for easier maintenance. | | 2026-04-29 | b09a3abb | Added security measure to restrict incoming traffic on port 5800 |
| 2026-04-29 | 229d8cbd | Corrected `caddy-docker-proxy` labels for proper configuration. |
| 2026-03-03 | 5ada055a | Updated Docker Swarm configuration for improved stability. |
| 2026-03-03 | 8dd63040 | Refactored environment variables for better organization. |
| 2026-01-10 | 1a374911 | Initial commit of swarm configuration files. |
Generated by Gremlin on 2026-04-30T13:24:18.203Z <Write a paragraph summarizing the evolution of this service based on the diffs above.>
Source: swarm/firefox.yaml
Review User Guide and Changelog sections The firefox stack has undergone significant changes in its recent commits, with improvements made to the Caddy reverse proxy configuration and security measures added to restrict incoming traffic on port 5800.
---
## Notes
- Generated by Gremlin on 2026-04-30T13:43:27.754Z
- Source: swarm/firefox.yaml
- Review User Guide and Changelog sections