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-29 23:15:49 -05:00
parent 6faf678d2c
commit d1bcda1aa3
1 changed files with 28 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,37 +2,38 @@
title: firefox Stack title: firefox Stack
description: Remote Browser for NetGrimoire description: Remote Browser for NetGrimoire
published: true published: true
date: 2026-04-30T04:12:27.879Z date: 2026-04-30T04:12:31.015Z
tags: docker,swarm,firefox,netgrimoire tags: docker,swarm,firefox,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-30T04:12:27.879Z dateCreated: 2026-04-30T04:12:31.015Z
--- ---
# firefox # firefox
## Overview ## Overview
The firefox stack is a NetGrimoire service that provides a remote browser interface for accessing web applications. The primary service is the `firefox` container, which runs in Docker Swarm mode. The firefox stack provides a remote browser service for NetGrimoire, allowing users to access a fully functional Firefox instance from within the network.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** firefox.netgrimoire.com - **Exposed via:** firefox.netgrimoire.com
- **Homepage group:** homepage.group: "Remote Access" - **Homepage group:** Remote Access
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. Ensure the environment is set up with the necessary Docker Swarm configuration files and environment variables.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/firefox mkdir -p /DockerVol/firefox
chown -R firefox:firefox /DockerVol/firefox chown -R user:group /DockerVol/firefox
``` ```
### Environment Variables ### Environment Variables
@ -41,7 +42,6 @@ chown -R firefox:firefox /DockerVol/firefox
PUID=1964 PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago TZ=America/Chicago
# add any other environment variables here
``` ```
### Deploy ### Deploy
@ -55,50 +55,47 @@ docker stack services firefox
``` ```
### First Run ### First Run
After the initial deployment, ensure that the `firefox` container is running and accessible at the exposed URL. After deployment, ensure that the `firefox` service is running and accessible through the Caddy reverse proxy.
--- ---
## User Guide ## User Guide
### Accessing firefox ### Accessing firefox
| Service | URL | Purpose | | Service | URL |
|---------|-----|---------| |---------|-----|
- **firefox** | http://firefox.netgrimoire.com | Remote Browser Interface | Caddy: firefox.netgrimoire.com
### Primary Use Cases ### Primary Use Cases
To access web applications using the remote browser interface, navigate to the `http://firefox.netgrimoire.com` URL in a supported browser. Use this service to access a remote Firefox instance for testing, development, or collaboration purposes within NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service integrates with other NetGrimoire services through environment variables and labels, including Kuma for monitoring and Uptime Kuma for uptime checks. This service integrates with other NetGrimoire services through environment variables and labels, including Uptime Kuma monitoring and the Homepage dashboard.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Monitor the `firefox` service using Uptime Kuma.
```bash ```bash
docker stack services firefox docker stack services firefox
docker service logs firefox docker service logs firefox
``` ```
### Backups ### Backups
Critical data is stored in the `/DockerVol/firefox` volume. Regular backups are recommended to ensure data integrity. Critical: Regular backups of the `/DockerVol/firefox` volume are essential to ensure data integrity. Reconstructable: The Docker Swarm configuration and environment variables can be restored from version control.
### Restore ### Restore
To restore the `firefox` container from a backup, run the following command: Restore the `firefox` service by running the `deploy.sh` script in the `services/swarm/stack/firefox` directory.
```bash
cd services/swarm/stack/firefox
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|---------|------|-----| |---------|-------|-----|
| Container not running | Insufficient resources or network issues | Check resource allocation and ensure network connectivity | | Service not running | Insufficient permissions on Docker Swarm configuration files | Ensure correct file ownership and permissions. |
| Browser interface not accessible | Incorrect environment variables or configuration | Verify environment variables and configuration files | | Firefox instance not accessible | Caddy reverse proxy issues | Verify that the Caddy service is configured correctly and running. |
--- ---
@ -106,18 +103,15 @@ cd services/swarm/stack/firefox
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-29 | a1853fe4 | Initial documentation for firefox stack | | 2026-04-29 | b09a3abb | Initial documentation and configuration |
| 2026-04-29 | 229d8cbd | Added kuma.* labels for monitoring integration | | 2026-04-29 | a1853fe4 | Updated Caddy labels for reverse proxy configuration |
| 2026-03-03 | 5ada055a | Improved volume setup and permissions | | 2026-04-29 | 229d8cbd | Fixed environment variable for PUID and PGID |
| 2026-03-03 | 8dd63040 | Enhanced security measures for environment variables | | 2026-03-03 | 5ada055a | Changed Docker Swarm service name to firefox |
| 2026-01-10 | 1a374911 | Initial implementation of firefox stack | | 2026-03-03 | 8dd63040 | Updated Uptime Kuma monitoring labels |
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
The firefox stack has undergone several improvements and refinements since its initial implementation. The recent commits have enhanced security measures, improved volume setup, and added monitoring integration through Kuma labels.
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-30T04:12:27.879Z Generated by Gremlin on 2026-04-30T04:12:31.015Z
- Source: swarm/firefox.yaml Source: swarm/firefox.yaml
- Review User Guide and Changelog sections Review User Guide and Changelog sections