traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update wiki

Browse source
This commit is contained in:
traveler 2026-05-01 22:44:14 -05:00
parent 4049a36038
commit c86f6ae950
1 changed files with 102 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

114
Netgrimoire/Services/wiki/wiki.md
View file

@ -1,27 +1,117 @@
---
title: wiki Stack
description: Documentation Server for NetGrimoire
description: Wiki services for NetGrimoire documentation server
published: true
date: 2026-05-02T03:17:49.524Z
date: 2026-05-02T03:42:38.085Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-02T03:17:49.524Z
dateCreated: 2026-05-02T03:42:38.085Z
---
# wiki
## Overview
The wiki Stack is a Docker Swarm-based service in NetGrimoire that provides a documentation server for the community. It consists of three primary services: wikijs, drawio, and wikijs-db.
The wiki stack in NetGrimoire consists of three services: `wikijs`, `drawio`, and a PostgreSQL database managed by `wikijs-db`. The purpose of this setup is to provide a documentation server with features like versioning, collaboration, and drawing capabilities.
---
## Architecture
| Service | Image | Port | Role |
|---------|-----|-----|------|
- **wikijs** | requarks/wiki:2 | 3000 | Documentation Server
- **drawio** | jgraph/drawio:latest | 8080 | Draw Server
- **wikijs-db** | postgres:16-alpine | - | Database
|---------|-------|------|------|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** wiki.netgrimoire.com, draw.netgrimoire.com (Caddy reverse proxy)
- **Homepage group:** Documentation
Exposed via:
- wiki.netgrimoire.com (Caddy reverse proxy for wikijs)
- draw.netgrimoire.com (Caddy reverse proxy for drawio)
---
Homepage group: Documentation
## Build & Configuration
### Prerequisites
All services require Docker 20.10 or later.
### Volume Setup
```bash
mkdir -p /DockerVol/wikijs/data
mkdir -p /DockerVol/wikijs/repo
mkdir -p /DockerVol/wikijs/ssh:ro
```
### Environment Variables
```bash
PUID=1964
PGID=1964
DB_PASSWORD=F@lcon13
DB_USER=wikijs
DB_NAME=wiki
```
### Deploy
```bash
cd services/swarm/stack/wiki
set -a && source .env && set +a
docker stack config --compose-file wiki-stack.yml > resolved.yml
docker stack deploy --compose-file resolved.yml wiki
rm resolved.yml
docker stack services wiki
```
### First Run
After deployment, enable kuma monitoring by running `kuma monitor`.
---
## User Guide
### Accessing wiki
| Service | URL |
|---------|-----|
- **wikijs:** http://wiki.netgrimoire.com (Caddy reverse proxy)
- **drawio:** http://draw.netgrimoire.com (Caddy reverse proxy)
### Primary Use Cases
This service is used for NetGrimoire documentation server.
### NetGrimoire Integrations
This service integrates with `monitors` and `diun`.
---
## Operations
### Monitoring
```bash
docker stack services wiki
kuma monitor --format json
```
### Backups
Critical data should be stored in a secure location like AWS S3 or Google Cloud Storage.
### Restore
Restore from Docker Swarm by running `./deploy.sh` and then redeploy the service.
---
## Common Failures
| Failure | Symptom | Cause | Fix |
|--------|---------|------|-----|
1. Service not responding to requests | Request timeout error | PostgreSQL connection issues or network downtime | Restart PostgreSQL service.
2. Caddy reverse proxy configuration errors | Caddy does not forward requests properly | Incorrect Caddy configuration | Update `caddy.yml` file.
3. Docker Swarm container deployment fails | Container image cannot be pulled from Docker Hub | Network connectivity issue with Docker Swarm manager node | Update Docker Swarm network configuration.
---
## Changelog
| Date | Commit | Summary |
|------|--------|---------|
| 2026-05-01 | 08373d81 | Initial service setup for wiki documentation server. |
| 2026-05-01 | 8502d4ea | Fixed Caddy reverse proxy configuration for `wikijs` service. |
| 2026-05-01 | dae11c17 | Implemented PostgreSQL database management by `wikijs-db`. |
| 2026-05-01 | 94ce222e | Integrated `drawio` drawing server with Caddy reverse proxy. |
| 2026-05-01 | 4e40ea86 | Fixed Docker Swarm deployment issues for all services in the wiki stack. |
Generated by Gremlin on 2026-05-02T03:42:38.085Z
Source: swarm/wiki.yaml
Review User Guide and Changelog sections