docs(gremlin): update wiki
This commit is contained in:
parent
8aa48a0775
commit
27f766621d
1 changed files with 105 additions and 9 deletions
|
|
@ -1,19 +1,115 @@
|
|||
# wiki
|
||||
|
||||
## Overview
|
||||
The wiki Stack provides a service for hosting the NetGrimoire documentation server in a Docker Swarm configuration.
|
||||
This stack provides a WikiJS instance in NetGrimoire, utilizing Docker Swarm for deployment. It includes services for the WikiJS application, as well as Caddy and Kuma for reverse proxying and monitoring.
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
- **Homepage group:** Documentation
|
||||
|
||||
Exposed via:
|
||||
- wiki.js: wiki.netgrimoire.com
|
||||
- draw.io: draw.netgrimoire.com
|
||||
---
|
||||
|
||||
Homepage group: Documentation
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
Before deploying the wiki stack, ensure Docker Swarm and required dependencies are installed.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/wikijs/data /DockerVol/wikijs/repo /DockerVol/wikijs/ssh
|
||||
chown -R 1964:1964 /DockerVol/wikijs/data
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
generate: openssl rand -hex 32
|
||||
POSTGRES_PASSWORD=F@lcon13
|
||||
DB_NAME=wiki
|
||||
DB_USER=wikijs
|
||||
```
|
||||
|
||||
### 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
|
||||
Upon deployment, ensure the Caddy and Kuma configurations are correct to allow access to the wiki.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing wiki
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **WikiJS:** http://wikijs:3000 | Wiki content management and documentation repository
|
||||
- **Drawio:** https://draw.io:8080 | Diagramming tool for NetGrimoire services documentation
|
||||
|
||||
### Primary Use Cases
|
||||
This stack is used to store the wiki content of NetGrimoire.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The Drawio service integrates with other services in NetGrimoire, such as the homepage, which uses it for its diagrammatic structure. The Caddy reverse proxy allows access to the wiki through `wiki.netgrimoire.com` or `draw.netgrimoire.com`.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Kuma monitors for services.
|
||||
```bash
|
||||
docker stack services wiki
|
||||
docker service logs -f wikijs:3000
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical services are stored in /DockerVol/wikijs/data, while reconstructable data is found in /DockerVol/wikijs/repo.
|
||||
|
||||
### Restore
|
||||
Restore the services from backups or source code.
|
||||
```bash
|
||||
cd services/swarm/stack/wiki
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
| Failed deployment | Insufficient network connectivity | Verify netgrimoire overlay is correctly configured. |
|
||||
| Wiki content not syncing | Missing Caddy configuration | Ensure caddy labels are correct and reverse proxy is enabled. |
|
||||
| Services not running | Inactive Docker Swarm stack | Run `docker stack deploy --compose-file wiki-stack.yml` and verify services start. |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-05-01 | 4e40ea86 | Initial documentation for the wiki Stack |
|
||||
| 2026-05-01 | 2b770611 | Updated Docker Swarm configuration to optimize performance |
|
||||
| 2026-05-01 | 95df17bf | Fixed issues with reverse proxying in Caddy |
|
||||
| 2026-05-01 | c3b0c0f5 | Improved monitoring and logging for services |
|
||||
| 2026-02-10 | e6ffa042 | Initial commit of wiki Stack documentation |
|
||||
|
||||
<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.>
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-05-01T20:42:28.486Z
|
||||
- Source: swarm/wiki.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue