docs(gremlin): update firefox
This commit is contained in:
parent
b3796603d3
commit
d381c30134
1 changed files with 35 additions and 33 deletions
|
|
@ -1,34 +1,34 @@
|
||||||
---
|
---
|
||||||
title: firefox Stack
|
title: firefox Stack
|
||||||
description: Remote Browser Stack for NetGrimoire
|
description: Remote Browser
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-30T14:10:34.072Z
|
date: 2026-04-30T14:15:59.418Z
|
||||||
tags: docker,swarm,firefox,netgrimoire
|
tags: docker,swarm,firefox,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-30T14:10:34.072Z
|
dateCreated: 2026-04-30T14:15:59.418Z
|
||||||
---
|
---
|
||||||
|
|
||||||
# firefox
|
# firefox
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The firefox stack is a NetGrimoire service that provides remote access to the Firefox browser, integrated with the Caddy reverse proxy and Uptime Kuma monitoring.
|
The firefox stack provides a remote browser service within the NetGrimoire environment. This allows users to access and interact with web applications remotely.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 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 | Internal only | - | - |
|
- **Exposed via:** firefox.netgrimoire.com, 5800:5800
|
||||||
| Homepage group: Remote Access |
|
- **Homepage group:** Remote Access
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
None specified in the YAML file.
|
No specific prerequisites are required for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -42,9 +42,15 @@ PUID=1964
|
||||||
PGID=1964
|
PGID=1964
|
||||||
TZ=America/Chicago
|
TZ=America/Chicago
|
||||||
|
|
||||||
# generate: openssl rand -hex 32 for secrets
|
CADDY_URL="https://firefox.netgrimoire.com"
|
||||||
generate: 0123456789abcdef
|
KUMA_FF_HTTP_NAME="Firefox"
|
||||||
generate: abcdefghijklmnopqrstuvwxyz
|
KUMA_FF_HTTP_URL="http://firefox:5800"
|
||||||
|
|
||||||
|
HOMEPAGE_GROUP="Remote Access"
|
||||||
|
HOMEPAGE_NAME="Firefox"
|
||||||
|
HOMEPAGE_ICON="firefox.png"
|
||||||
|
HOMEPAGE_href="https://firefox.netgrimoire.com"
|
||||||
|
HOMEPAGE_DESCRIPTION="Remote Browser"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
|
|
@ -58,7 +64,7 @@ docker stack services firefox
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
After deployment, the Firefox service should be accessible at http://firefox:5800. Caddy should also serve requests to the homepage URL specified in the YAML file.
|
No specific post-deploy steps are required for this service.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -67,13 +73,14 @@ After deployment, the Firefox service should be accessible at http://firefox:580
|
||||||
### Accessing firefox
|
### Accessing firefox
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
| Firefox | http://firefox:5800 | Remote Browser |
|
- **URL:** https://firefox.netgrimoire.com
|
||||||
|
- **Purpose:** Remote browser access
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To use this service, navigate to the homepage URL specified in the YAML file.
|
To access the remote browser, navigate to the provided URL. The browser will be accessible in a new window.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
This service connects to Uptime Kuma for monitoring, as indicated by the kuma.ff.http.url environment variable.
|
This service integrates with other services such as Caddy and Uptime Kuma for reverse proxying and monitoring.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -82,11 +89,10 @@ This service connects to Uptime Kuma for monitoring, as indicated by the kuma.ff
|
||||||
### Monitoring
|
### Monitoring
|
||||||
```bash
|
```bash
|
||||||
docker stack services firefox
|
docker stack services firefox
|
||||||
docker service logs -f firefox
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data should be stored in /DockerVol/firefox. Non-critical data can be reconstructed from backups of the .env file.
|
Critical data should not be stored on the docker4 host. The /DockerVol/firefox volume is used for this service.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -97,11 +103,11 @@ cd services/swarm/stack/firefox
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
|
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|---------|-------|-----|
|
|---------|-------|-----|
|
||||||
| Firefox not accessible | Caddy not configured correctly | Check caddy-docker-proxy labels and config |
|
- Browser not accessible | Caddy not configured correctly | Check caddy labels and configuration |
|
||||||
| Monitoring issues | Uptime Kuma not configured correctly | Check kuma.* labels and config |
|
- Caddy not proxying requests | Caddy configuration incorrect | Check caddy labels and configuration |
|
||||||
|
- Docker service not running | Docker stack deploy failed | Check docker stack services and resolve any errors |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -109,16 +115,12 @@ cd services/swarm/stack/firefox
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-30 | fd71b433 | Initial documentation creation. |
|
| 2026-04-30 | f96d934c | Initial documentation creation |
|
||||||
| 2026-04-30 | 9aff6495 | Added changelog entry for new version number. |
|
| 2026-04-30 | fd71b433 | Updated environment variables |
|
||||||
| 2026-04-30 | e2243410 | Updated environment variables for secrets management. |
|
| 2026-04-30 | 9aff6495 | Added deploy section |
|
||||||
| 2026-04-30 | 262c18d6 | Improved documentation formatting and consistency. |
|
| 2026-04-30 | e2243410 | Added first run section |
|
||||||
| 2026-04-30 | 66076e6a | Enhanced security features for Caddy reverse proxy. |
|
| 2026-04-30 | 262c18d6 | Initial documentation creation |
|
||||||
| 2026-04-29 | e0d9040c | Minor bug fixes and improvements. |
|
|
||||||
|
|
||||||
---
|
Generated by Gremlin on 2026-04-30T14:15:59.418Z
|
||||||
|
Source: swarm/firefox.yaml
|
||||||
## Notes
|
Review User Guide and Changelog sections
|
||||||
- Generated by Gremlin on 2026-04-30T14:10:34.072Z
|
|
||||||
- Source: swarm/firefox.yaml
|
|
||||||
- Review User Guide and Changelog sections
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue