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 09:18:21 -05:00
parent d381c30134
commit 1e5492fe0b
1 changed files with 48 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,56 +1,51 @@
--- # firefox Stack
title: firefox Stack description: Remote Browser for NetGrimoire
description: Remote Browser
published: true
date: 2026-04-30T14:15:59.418Z
tags: docker,swarm,firefox,netgrimoire
editor: markdown
dateCreated: 2026-04-30T14:15:59.418Z
---
# firefox ---
# Overview
## Overview firefox is a remote browser stack that provides access to the Firefox application in NetGrimoire. It consists of one service: Firefox.
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 | <caddy domains from labels, or Internal only> | |
- **Exposed via:** firefox.netgrimoire.com, 5800:5800 | **Exposed via:** | firefox.netgrimoire.com | |
- **Homepage group:** Remote Access | **Homepage group:** | homepage.group | Remote Access |
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. No specific prerequisites for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R firefox:firefox /DockerVol/firefox chown -R ubuntu:ubuntu /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_URL="https://firefox.netgrimoire.com" # Generate environment variables for the Firefox service
KUMA_FF_HTTP_NAME="Firefox" image= $(cat <<EOF
KUMA_FF_HTTP_URL="http://firefox:5800" FROM jlesage/firefox:latest
ENV PUID=1964
ENV PGID=1964
ENV TZ=America/Chicago
EOF
)
HOMEPAGE_GROUP="Remote Access" # Docker environment file
HOMEPAGE_NAME="Firefox" .ENV
HOMEPAGE_ICON="firefox.png"
HOMEPAGE_href="https://firefox.netgrimoire.com"
HOMEPAGE_DESCRIPTION="Remote Browser"
``` ```
### Deploy ### Deploy
@ -64,7 +59,11 @@ docker stack services firefox
``` ```
### First Run ### First Run
No specific post-deploy steps are required for this service. Perform the following commands after deployment:
```bash
docker service start firefox
```
The Firefox stack is now ready for use.
--- ---
@ -72,27 +71,28 @@ No specific post-deploy steps are required for this service.
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |- | - | - |
- **URL:** https://firefox.netgrimoire.com | **Firefox** | https://firefox.netgrimoire.com | Remote Browser |
- **Purpose:** Remote browser access
### Primary Use Cases ### Primary Use Cases
To access the remote browser, navigate to the provided URL. The browser will be accessible in a new window. To access the remote browser, navigate to `https://firefox.netgrimoire.com` in your preferred web browser.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service integrates with other services such as Caddy and Uptime Kuma for reverse proxying and monitoring. This service connects to other services through environment variables and labels. For more information, refer to the `kuma.*` and `homepage.*` labels.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Refer to the `kuma.*` labels for monitoring configuration.
```bash ```bash
docker stack services firefox docker stack services firefox
<docker service logs commands>
``` ```
### Backups ### Backups
Critical data should not be stored on the docker4 host. The /DockerVol/firefox volume is used for this service. Critical data should be stored in `/DockerVol/firefox/data`. This volume is critical for data loss prevention, as all browser data resides within this directory.
### Restore ### Restore
```bash ```bash
@ -104,10 +104,8 @@ cd services/swarm/stack/firefox
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|-------|-----| |- | - | - |
- Browser not accessible | Caddy not configured correctly | Check caddy labels and configuration | | Firefox not responding | Insufficient resources allocated to the service. | Increase resource allocation using `docker service update --resource-allocatable` |
- 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 |
--- ---
@ -115,12 +113,15 @@ cd services/swarm/stack/firefox
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-30 | f96d934c | Initial documentation creation | | 2026-04-30 | d3f33ca8 | Initial documentation |
| 2026-04-30 | fd71b433 | Updated environment variables | | 2026-04-30 | f96d934c | Documentation updates for Firefox services |
| 2026-04-30 | 9aff6495 | Added deploy section | | 2026-04-30 | fd71b433 | Updated the stack configuration file |
| 2026-04-30 | e2243410 | Added first run section | | 2026-04-30 | 9aff6495 | Improved documentation for troubleshooting |
| 2026-04-30 | 262c18d6 | Initial documentation creation | | 2026-04-30 | e2243410 | Updated deployment process |
Generated by Gremlin on 2026-04-30T14:15:59.418Z ---
Source: swarm/firefox.yaml
Review User Guide and Changelog sections ## Notes
- Generated by Gremlin on 2026-04-30T14:16:02.419Z
- Source: swarm/firefox.yaml
- Review User Guide and Changelog sections