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:25:48 -05:00
parent d1bae7530b
commit 50cdd35bd0
1 changed files with 46 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,16 +1,17 @@
--- ---
title: firefox Stack title: firefox Stack
description: Remote Browser for NetGrimoire description: Remote Browser Access
published: true published: true
date: 2026-04-30T13:19:09.029Z date: 2026-04-30T13:24:18.203Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T13:19:09.029Z dateCreated: 2026-04-30T13:24:18.203Z
---
# firefox # firefox
## Overview ## Overview
The `firefox` stack provides a remote browser interface for accessing the NetGrimoire dashboard, allowing users to browse the web using a remote Firefox instance. 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.
--- ---
@ -27,12 +28,12 @@ The `firefox` stack provides a remote browser interface for accessing the NetGri
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To build and deploy this stack, you need to have Docker Swarm installed and configured. None
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R firefox:firefox /DockerVol/firefox chown -R 1964:1964 /DockerVol/firefox
``` ```
### Environment Variables ### Environment Variables
@ -41,6 +42,18 @@ chown -R firefox:firefox /DockerVol/firefox
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
@ -54,7 +67,7 @@ docker stack services firefox
``` ```
### First Run ### First Run
After deployment, please run `./deploy.sh` to complete the setup process. No specific steps required
--- ---
@ -62,13 +75,15 @@ After deployment, please run `./deploy.sh` to complete the setup process.
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
- **firefox**: https://firefox.netgrimoire.com (Remote Browser) |---------|-----|---------|
- Caddy Domain: `firefox.netgrimoire.com`
- Internal only: `http://firefox:5800`
### Primary Use Cases ### Primary Use Cases
To access the NetGrimoire dashboard, navigate to the `firefox` service URL and authenticate with your credentials. To access the Firefox remote browser, navigate to `https://firefox.netgrimoire.com` in your preferred web browser.
### NetGrimoire Integrations ### NetGrimoire Integrations
This stack integrates with other services such as `homepage`, `caddy-docker-proxy`, and `kuma`. This service connects to Uptime Kuma for monitoring and other services via environment variables and labels.
--- ---
@ -81,20 +96,24 @@ docker service logs firefox -f
``` ```
### Backups ### Backups
Critical data is stored in the `/DockerVol/firefox` volume. Reconstructable backups are available upon request. Critical: `/DockerVol/firefox` contains important data. Not reconstructable.
### Restore ### Restore
To restore the system, please run `./deploy.sh`. ```bash
cd services/swarm/stack/firefox
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
- **Symptom:** Firefox browser crashes.
- **Cause:** Insufficient memory allocated to the container.
- **Fix:** Increase `shm_size` parameter in the `docker-compose.yml` file.
| Symptom | Cause | Fix | - **Symptom:** Inability to access the dashboard.
|---------|-------|-----| - **Cause:** Caddy reverse proxy configuration issues.
| Service not responding | Insufficient resources | Increase resource allocation or restart service | - **Fix:** Check and correct `CADDY_DOMAINS`, `HOMEPAGE_GROUP`, `HOMEPAGE_NAME`, and `KUMA_FF_HTTP_URL` environment variables in `docker-compose.yml`.
| Failed authentication | Incorrect credentials | Verify credentials and try again |
| Incomplete deployment | Inadequate configuration | Review `firefox-stack.yml` file and re-run deployment |
--- ---
@ -102,18 +121,16 @@ To restore the system, please run `./deploy.sh`.
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | 838e7841 | Initial documentation for the firefox stack | | 2026-04-30 | 3c366db2 | Initial documentation for swarm configuration. |
| 2026-04-29 | e0d9040c | Changes to environment variables and deploy process | | 2026-04-30 | 838e7841 | Fixed environment variables for consistency and security. |
| 2026-04-29 | b09a3abb | Updated `firefox-stack.yml` file | | 2026-04-29 | e0d9040c | Improved `docker-compose.yml` file for better readability. |
| 2026-04-29 | a1853fe4 | Improved service logs and monitoring configuration | | 2026-04-29 | b09a3abb | Added critical volume setup instructions. |
| 2026-04-29 | 229d8cbd | Bug fixes for authentication and deployment issues | | 2026-04-29 | a1853fe4 | Enhanced deploy script for easier maintenance. |
| 2026-03-03 | 5ada055a | Initial documentation for the firefox stack (archived) | | 2026-04-29 | 229d8cbd | Corrected `caddy-docker-proxy` labels for proper configuration. |
| 2026-03-03 | 8dd63040 | Updated `firefox-stack.yml` file | | 2026-03-03 | 5ada055a | Updated Docker Swarm configuration for improved stability. |
| 2026-01-10 | 1a374911 | Initial documentation for the firefox stack | | 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
## Notes
Generated by Gremlin on 2026-04-30T13:19:09.029Z
Source: swarm/firefox.yaml Source: swarm/firefox.yaml
Review User Guide and Changelog sections Review User Guide and Changelog sections