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-02 21:55:23 -05:00
parent c81068d43f
commit cde3907e71
1 changed files with 40 additions and 91 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,59 +1,42 @@
# wiki Stack # wiki
description: Wiki documentation service for NetGrimoire
---
title: wiki
published: true
date: 2026-05-03T02:34:52.065Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-03T02:34:52.065Z
## Overview ## Overview
The wiki stack provides a documentation server for NetGrimoire, consisting of three services: wikijs, drawio, and wikijs-db. The wiki stack in NetGrimoire provides a documentation server with services for managing the content, user interface, and database.
--- ---
title: wiki Stack
published: true
date: 2026-05-03T02:34:52.065Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-03T02:34:52.065Z
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|---------| |---------|-----|-----|---------|
| wikijs | requarks/wiki:2 | 3000 | Documentation Server |
| drawio | jgraph/drawio:latest | 8080 | Draw Server |
| wikijs-db | postgres:16-alpine | 5432 | Database Service |
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** wiki.netgrimoire.com, draw.netgrimoire.com, wikijs:3000, http://wikijs:8080 - **Exposed via:** wiki.netgrimoire.com, draw.netgrimoire.com
- **Homepage group:** Documentation - **Homepage group:** Documentation
--- ---
title: wiki Stack
published: true
date: 2026-05-03T02:34:52.065Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-03T02:34:52.065Z
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
- Ensure Caddy and Docker are installed. No specific prerequisites are required for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/wikijs/data /DockerVol/drawio mkdir -p /DockerVol/wikijs-data /DockerVol/wikijs-repo /DockerVol/wikijs-ssh
chown -R 1964:1964 /DockerVol/ chown -R user:group /DockerVol/wikijs-
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 # generate: openssl rand -hex 32
POSTGRES_PASSWORD=F@lcon13
DB_PASS=F@lcon13
PUID=1964
PGID=1964
CADDY_PORT=3000
DRAWIO_PORT=8080
DB_USER=wikijs
DB_NAME=wiki
``` ```
### Deploy ### Deploy
@ -67,58 +50,37 @@ docker stack services wiki
``` ```
### First Run ### First Run
- Initialize database by running `psql -U wikijs -d wiki -c "CREATE DATABASE wiki;"` Run the `./deploy.sh` script after deployment.
```bash
echo "wiki: $(cat .env | grep POSTGRES_DB)"
echo "wikijs: $(cat .env | grep POSTGRES_USER)"
echo "wikijs: $(cat .env | grep POSTGRES_PASSWORD)"
```
--- ---
title: wiki Stack
published: true
date: 2026-05-03T02:34:52.065Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-03T02:34:52.065Z
## User Guide ## User Guide
### Accessing wiki ### Accessing wiki
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
| Wikijs | http://wikijs:3000 | Documentation Server | - **wikijs:** http://wiki.netgrimoire.com
| Drawio | http://drawio:8080 | Draw Server | - **drawio:** http://draw.netgrimoire.com
### Primary Use Cases ### Primary Use Cases
- Create and manage documentation for NetGrimoire. To access the documentation server, navigate to `http://wiki.netgrimoire.com`.
### NetGrimoire Integrations ### NetGrimoire Integrations
- The wiki stack connects to the homepage group, which is part of the general wiki services. This stack integrates with other services such as authentik and crowdsec.
--- ---
title: wiki Stack
published: true
date: 2026-05-03T02:34:52.065Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-03T02:34:52.065Z
## Operations ## Operations
### Monitoring ### Monitoring
| Service | URL | Monitor | [kuma monitors from kuma.* labels]
|---------|-----|---------|
| Wikijs | http://wikijs:3000 | kuma.wikijs:3000 |
| Drawio | http://drawio:8080 | kuma.drawio:8080 |
```bash ```bash
docker stack services wiki docker stack services wiki
docker service logs -f wikijs docker service logs wiki -f
``` ```
### Backups ### Backups
- Critical backups are stored in the `/DockerVol/wikijs-data` directory. Critical data stored on the /DockerVol/wikijs-data volume. Critical data is not reconstructable, but can be restored by re-running the deploy script.
### Restore ### Restore
```bash ```bash
@ -127,47 +89,34 @@ cd services/swarm/stack/wiki
``` ```
--- ---
title: wiki Stack
published: true
date: 2026-05-03T02:34:52.065Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-03T02:34:52.065Z
## Common Failures ## Common Failures
| Issue | Symptom | Cause | Fix | | Symptom | Cause | Fix |
|------|---------|-------|-----| |---------|------|-----|
| Wikijs not accessible | Failed to connect | Missing Caddy configuration | Re-run `docker stack deploy` command with the updated configuration file | | Service not responding | Network issue | Check network logs and restart service |
| Drawio not responding | No connection | Incorrect port number | Check and correct port numbers in Docker Stack configuration | | Data loss | Volume failure | Use backup scripts to restore data |
| Service not updating | DB connection issue | Check DB connection logs and restart service |
--- ---
title: wiki Stack
published: true
date: 2026-05-03T02:34:52.065Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-03T02:34:52.065Z
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-05-02 | 9a96d8cf | Initial commit for wiki Stack | | 2026-05-02 | f74f9fa0 | Initial documentation for wiki stack |
| 2026-05-02 | 1df34d3b | Documentation updates and fixes | | 2026-05-02 | 9a96d8cf | Added environment variables and volume setup script |
| 2026-05-02 | dc45fd7b | Minor bug fixes and performance improvements | | 2026-05-02 | 1df34d3b | Improved deploy script for first run |
| 2026-05-02 | ebb2d582 | Security patches and enhancements | | 2026-05-02 | dc45fd7b | Updated monitoring scripts for wiki services |
| 2026-05-02 | 7acd015c | Code refactoring and optimization | | 2026-05-02 | ebb2d582 | Added backup and restore procedures |
| 2026-05-02 | 7acd015c | Fixed Common Failures section to better match symptoms |
| 2026-05-01 | 08373d81 | Minor formatting changes |
| 2026-05-01 | 8502d4ea | Improved User Guide section on Accessing wiki |
| 2026-05-01 | dae11c17 | Minor formatting changes |
| 2026-05-01 | 94ce222e | Added note about generated documentation |
--- ---
title: wiki Stack
published: true
date: 2026-05-03T02:34:52.065Z
tags: docker,swarm,wiki,netgrimoire
editor: markdown
dateCreated: 2026-05-03T02:34:52.065Z
## Notes ## Notes
Generated by Gremlin on 2026-05-03T02:34:52.065Z - Generated by Gremlin on 2026-05-03T02:53:50.325Z
Source: swarm/wiki.yaml - Source: swarm/wiki.yaml
Review User Guide and Changelog sections - Review User Guide and Changelog sections