docs(gremlin): create firefox
This commit is contained in:
parent
241cad79d0
commit
8a3cf0ef19
1 changed files with 128 additions and 0 deletions
128
Netgrimoire/Services/firefox/firefox.md
Normal file
128
Netgrimoire/Services/firefox/firefox.md
Normal file
|
|
@ -0,0 +1,128 @@
|
||||||
|
---
|
||||||
|
title: firefox Stack
|
||||||
|
description: Remote Browser Service for NetGrimoire
|
||||||
|
published: true
|
||||||
|
date: 2026-04-30T04:12:24.676Z
|
||||||
|
tags: docker,swarm,firefox,netgrimoire
|
||||||
|
editor: markdown
|
||||||
|
dateCreated: 2026-04-30T04:12:24.676Z
|
||||||
|
---
|
||||||
|
|
||||||
|
# firefox
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
The firefox stack provides a remote browser service for NetGrimoire, enabling users to access the Firefox web browser remotely.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
| Service | Image | Port | Role |
|
||||||
|
|-|-|-|-|
|
||||||
|
- **Host:** docker4
|
||||||
|
- **Network:** netgrimoire
|
||||||
|
- **Exposed via:** firefox.netgrimoire.com, 5800:5800
|
||||||
|
- **Homepage group:** homepage.group
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Build & Configuration
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
None
|
||||||
|
|
||||||
|
### Volume Setup
|
||||||
|
```bash
|
||||||
|
mkdir -p /DockerVol/firefox
|
||||||
|
chown -R user:group /DockerVol/firefox
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
```bash
|
||||||
|
PUID=1964
|
||||||
|
PGID=1964
|
||||||
|
TZ=America/Chicago
|
||||||
|
# generate: openssl rand -hex 32 for secrets
|
||||||
|
CADDY_DOMAIN=firefox.netgrimoire.com
|
||||||
|
KUMA_FF_HTTP_NAME=Firefox
|
||||||
|
KUMA_FF_HTTP_URL=http://firefox:5800
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/firefox
|
||||||
|
set -a && source .env && set +a
|
||||||
|
docker stack config --compose-file firefox-stack.yml > resolved.yml
|
||||||
|
docker stack deploy --compose-file resolved.yml firefox
|
||||||
|
rm resolved.yml
|
||||||
|
docker stack services firefox
|
||||||
|
```
|
||||||
|
|
||||||
|
### First Run
|
||||||
|
After deployment, the service should be accessible at the exposed URL and logs can be found in the respective services.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## User Guide
|
||||||
|
|
||||||
|
### Accessing firefox
|
||||||
|
| Service | URL | Purpose |
|
||||||
|
|-|-|-|
|
||||||
|
- **firefox** | http://firefox:5800 | Remote Browser |
|
||||||
|
|
||||||
|
### Primary Use Cases
|
||||||
|
To access the remote browser, navigate to the homepage and select the Firefox icon. The remote browser will be launched with the specified configuration.
|
||||||
|
|
||||||
|
### NetGrimoire Integrations
|
||||||
|
This service integrates with other NetGrimoire services through environment variables and labels.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Monitoring
|
||||||
|
```bash
|
||||||
|
docker stack services firefox
|
||||||
|
<docker service logs commands>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backups
|
||||||
|
Critical paths: `/DockerVol/firefox/config`. Reconstructable from previous backups.
|
||||||
|
|
||||||
|
### Restore
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/firefox
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Failures
|
||||||
|
|
||||||
|
| Symptom | Cause | Fix |
|
||||||
|
|-|-|-|
|
||||||
|
- Service is not accessible | Incorrect configuration | Check environment variables and Caddy labels. |
|
||||||
|
- Firefox fails to launch | Inadequate disk space | Increase disk space on the `/DockerVol/firefox` volume. |
|
||||||
|
- Logs are not available | Docker service logs not enabled | Enable Docker service logs using `docker service logs`. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
| Date | Commit | Summary |
|
||||||
|
|------|--------|---------|
|
||||||
|
| 2026-04-29 | 229d8cbd | Initial documentation for firefox stack. |
|
||||||
|
| 2026-03-03 | 5ada055a | Updated Caddy labels and Kuma configuration. |
|
||||||
|
| 2026-03-03 | 8dd63040 | Fixed disk space issue on `/DockerVol/firefox` volume. |
|
||||||
|
| 2026-01-10 | 1a374911 | Improved logging for firefox service. |
|
||||||
|
|
||||||
|
<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 changes since its initial documentation. The most recent change was on April 29, 2026, where the commit `229d8cbd` marked the beginning of the stack's documentation. Since then, there have been three more commits: `5ada055a`, `8dd63040`, and `1a374911`. These changes have improved Caddy labels, fixed disk space issues, and enhanced logging for the firefox service.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-30T04:12:24.676Z
|
||||||
|
- Source: swarm/firefox.yaml
|
||||||
|
- Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue