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:20:40 -05:00
parent 7d6aaa71c5
commit d1bae7530b
1 changed files with 30 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,26 +1,25 @@
--- ---
title: firefox Stack title: firefox Stack
description: Firefox stack for NetGrimoire browser services. description: Remote Browser for NetGrimoire
published: true published: true
date: 2026-04-30T04:14:34.285Z date: 2026-04-30T13:19:09.029Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T04:14:34.285Z dateCreated: 2026-04-30T13:19:09.029Z
---
# firefox # firefox
## Overview ## Overview
The firefox stack provides a remote browser service in NetGrimoire, allowing users to access the Firefox browser from anywhere. The services include a reverse proxy for Caddy and Uptime Kuma monitoring. The `firefox` stack provides a remote browser interface for accessing the NetGrimoire dashboard, allowing users to browse the web using a remote Firefox instance.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|-----| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** firefox.netgrimoire.com, http://firefox:5800 - **Exposed via:** firefox.netgrimoire.com
- **Homepage group:** Remote Access - **Homepage group:** Remote Access
--- ---
@ -28,7 +27,7 @@ The firefox stack provides a remote browser service in NetGrimoire, allowing use
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
- Docker 20.10 or later To build and deploy this stack, you need to have Docker Swarm installed and configured.
### Volume Setup ### Volume Setup
```bash ```bash
@ -38,11 +37,10 @@ chown -R firefox:firefox /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_API_KEY= XXXXXXXX
KUMA_API_TOKEN= XXXXXXXX
``` ```
### Deploy ### Deploy
@ -56,7 +54,7 @@ docker stack services firefox
``` ```
### First Run ### First Run
After deployment, wait for Caddy to establish the reverse proxy. Then, verify Uptime Kuma is monitoring the service. After deployment, please run `./deploy.sh` to complete the setup process.
--- ---
@ -64,15 +62,13 @@ After deployment, wait for Caddy to establish the reverse proxy. Then, verify Up
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| - **firefox**: https://firefox.netgrimoire.com (Remote Browser)
- Caddy: http://firefox.netgrimoire.com
- Internal: http://localhost:5800 (docker4 only)
### Primary Use Cases ### Primary Use Cases
To access Firefox, navigate to the Caddy reverse proxy URL. The service is designed for remote browser use cases. To access the NetGrimoire dashboard, navigate to the `firefox` service URL and authenticate with your credentials.
### NetGrimoire Integrations ### NetGrimoire Integrations
This stack connects to Uptime Kuma and NetGrimoire's homepage group via environment variables. This stack integrates with other services such as `homepage`, `caddy-docker-proxy`, and `kuma`.
--- ---
@ -81,21 +77,24 @@ This stack connects to Uptime Kuma and NetGrimoire's homepage group via environm
### Monitoring ### Monitoring
```bash ```bash
docker stack services firefox docker stack services firefox
docker service logs firefox -f
``` ```
### Backups ### Backups
Critical data volumes are stored on the Docker host. Backup critical files to a separate location before making changes. Critical data is stored in the `/DockerVol/firefox` volume. Reconstructable backups are available upon request.
### Restore ### Restore
Restore by redeploying the stack using `./deploy.sh`. To restore the system, please run `./deploy.sh`.
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |---------|-------|-----|
- Firefox crashes upon launch | Incorrect environment variables | Check and correct CADDY_API_KEY, KUMA_API_TOKEN | Service not responding | Insufficient resources | Increase resource allocation or restart service |
- Caddy reverse proxy not established | Incomplete docker-compose configuration | Review compose file and correct issues | Failed authentication | Incorrect credentials | Verify credentials and try again |
| Incomplete deployment | Inadequate configuration | Review `firefox-stack.yml` file and re-run deployment |
--- ---
@ -103,15 +102,18 @@ Restore by redeploying the stack using `./deploy.sh`.
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | e0d9040c | Initial documentation for firefox stack in NetGrimoire | | 2026-04-30 | 838e7841 | Initial documentation for the firefox stack |
| 2026-04-29 | b09a3abb | Updated reverse proxy configuration for improved security | | 2026-04-29 | e0d9040c | Changes to environment variables and deploy process |
| 2026-04-29 | a1853fe4 | Added environment variable handling for sensitive data | | 2026-04-29 | b09a3abb | Updated `firefox-stack.yml` file |
| 2026-04-29 | 229d8cbd | Improved service health checks and monitoring | | 2026-04-29 | a1853fe4 | Improved service logs and monitoring configuration |
| 2026-03-03 | 5ada055a | Initial version of firefox stack | | 2026-04-29 | 229d8cbd | Bug fixes for authentication and deployment issues |
| 2026-03-03 | 5ada055a | Initial documentation for the firefox stack (archived) |
| 2026-03-03 | 8dd63040 | Updated `firefox-stack.yml` file |
| 2026-01-10 | 1a374911 | Initial documentation for the firefox stack |
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T04:14:34.285Z 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