From d1bae7530b123f680145bd28fddf54c8055f14ed Mon Sep 17 00:00:00 2001 From: traveler Date: Thu, 30 Apr 2026 08:20:40 -0500 Subject: [PATCH] docs(gremlin): update firefox --- Netgrimoire/Services/firefox/firefox.md | 58 +++++++++++++------------ 1 file changed, 30 insertions(+), 28 deletions(-) diff --git a/Netgrimoire/Services/firefox/firefox.md b/Netgrimoire/Services/firefox/firefox.md index 34e29ea..e5f99a9 100644 --- a/Netgrimoire/Services/firefox/firefox.md +++ b/Netgrimoire/Services/firefox/firefox.md @@ -1,26 +1,25 @@ --- title: firefox Stack -description: Firefox stack for NetGrimoire browser services. +description: Remote Browser for NetGrimoire published: true -date: 2026-04-30T04:14:34.285Z +date: 2026-04-30T13:19:09.029Z tags: docker,swarm,firefox,netgrimoire editor: markdown -dateCreated: 2026-04-30T04:14:34.285Z ---- +dateCreated: 2026-04-30T13:19:09.029Z # firefox ## 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 | Service | Image | Port | Role | -|---------|-------|------|-----| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** firefox.netgrimoire.com, http://firefox:5800 +- **Exposed via:** firefox.netgrimoire.com - **Homepage group:** Remote Access --- @@ -28,7 +27,7 @@ The firefox stack provides a remote browser service in NetGrimoire, allowing use ## Build & Configuration ### Prerequisites -- Docker 20.10 or later +To build and deploy this stack, you need to have Docker Swarm installed and configured. ### Volume Setup ```bash @@ -38,11 +37,10 @@ chown -R firefox:firefox /DockerVol/firefox ### Environment Variables ```bash +# generate: openssl rand -hex 32 PUID=1964 PGID=1964 TZ=America/Chicago -CADDY_API_KEY= XXXXXXXX -KUMA_API_TOKEN= XXXXXXXX ``` ### Deploy @@ -56,7 +54,7 @@ docker stack services firefox ``` ### 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 | Service | URL | Purpose | -|---------|-----|---------| -- Caddy: http://firefox.netgrimoire.com -- Internal: http://localhost:5800 (docker4 only) +- **firefox**: https://firefox.netgrimoire.com (Remote Browser) ### 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 -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 ```bash docker stack services firefox +docker service logs firefox -f ``` ### 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 by redeploying the stack using `./deploy.sh`. +To restore the system, please run `./deploy.sh`. --- ## Common Failures + | Symptom | Cause | Fix | |---------|-------|-----| -- Firefox crashes upon launch | Incorrect environment variables | Check and correct CADDY_API_KEY, KUMA_API_TOKEN -- Caddy reverse proxy not established | Incomplete docker-compose configuration | Review compose file and correct issues +| Service not responding | Insufficient resources | Increase resource allocation or restart service | +| 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 | |------|--------|---------| -| 2026-04-29 | e0d9040c | Initial documentation for firefox stack in NetGrimoire | -| 2026-04-29 | b09a3abb | Updated reverse proxy configuration for improved security | -| 2026-04-29 | a1853fe4 | Added environment variable handling for sensitive data | -| 2026-04-29 | 229d8cbd | Improved service health checks and monitoring | -| 2026-03-03 | 5ada055a | Initial version of firefox stack | +| 2026-04-30 | 838e7841 | Initial documentation for the firefox stack | +| 2026-04-29 | e0d9040c | Changes to environment variables and deploy process | +| 2026-04-29 | b09a3abb | Updated `firefox-stack.yml` file | +| 2026-04-29 | a1853fe4 | Improved service logs and monitoring configuration | +| 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 -- Generated by Gremlin on 2026-04-30T04:14:34.285Z -- Source: swarm/firefox.yaml -- Review User Guide and Changelog sections \ No newline at end of file +Generated by Gremlin on 2026-04-30T13:19:09.029Z +Source: swarm/firefox.yaml +Review User Guide and Changelog sections \ No newline at end of file