docs(gremlin): update wiki
This commit is contained in:
parent
b6e52ad2fb
commit
8aa48a0775
1 changed files with 8 additions and 104 deletions
|
|
@ -1,115 +1,19 @@
|
||||||
# wiki
|
# wiki
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
This stack provides a Wiki.js service in NetGrimoire, offering documentation for various services and features.
|
The wiki Stack provides a service for hosting the NetGrimoire documentation server in a Docker Swarm configuration.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|:---------|-------:|-----:|------|
|
|-|-|-|-|
|
||||||
| **wikijs** | `requarks/wiki:2` | 3000 | Documentation Server |
|
- **wikijs** | requarks/wiki:2 | 3000 | Documentation Server |
|
||||||
|
- **drawio** | jgraph/drawio:latest | 8080 | Draw Server |
|
||||||
|
- **wikijs-db** | postgres:16-alpine | - | Database |
|
||||||
|
|
||||||
Exposed via:
|
Exposed via:
|
||||||
- `caddy.netgrimoire.com`
|
- wiki.js: wiki.netgrimoire.com
|
||||||
- Internal only
|
- draw.io: draw.netgrimoire.com
|
||||||
|
|
||||||
Homepage group:
|
Homepage group: Documentation
|
||||||
- `Documentation`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Build & Configuration
|
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
No specific prerequisites for this stack.
|
|
||||||
|
|
||||||
### Volume Setup
|
|
||||||
```bash
|
|
||||||
mkdir -p /DockerVol/wikijs/data
|
|
||||||
chown -R wikijs:wikijs /DockerVol/wikijs
|
|
||||||
```
|
|
||||||
|
|
||||||
### Environment Variables
|
|
||||||
```bash
|
|
||||||
DB_TYPE=postgres
|
|
||||||
DB_HOST=wikijs-db
|
|
||||||
DB_PORT=5432
|
|
||||||
DB_USER=wikijs
|
|
||||||
DB_PASS=F@lcon13
|
|
||||||
TZ=America/Chicago
|
|
||||||
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
|
|
||||||
Run `caddy` command to start the reverse proxy and make the service accessible.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## User Guide
|
|
||||||
|
|
||||||
### Accessing wiki
|
|
||||||
| Service | URL |
|
|
||||||
|---------|-----|
|
|
||||||
- **wikijs** | https://wiki.netgrimoire.com |
|
|
||||||
|
|
||||||
### Primary Use Cases
|
|
||||||
Use this service for documentation purposes, such as updating wiki pages or contributing to the wiki.
|
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
|
||||||
Connects to `drawio` and other services via Kuma labels.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Operations
|
|
||||||
|
|
||||||
### Monitoring
|
|
||||||
Kuma monitors:
|
|
||||||
```bash
|
|
||||||
docker stack services wiki
|
|
||||||
<docker service logs commands>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Backups
|
|
||||||
Critical vs reconstructable `/DockerVol/wikijs/data` volume.
|
|
||||||
|
|
||||||
### Restore
|
|
||||||
Run `./deploy.sh` to restore the service.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Common Failures
|
|
||||||
| Symptom | Cause | Fix |
|
|
||||||
|---------|------|-----|
|
|
||||||
| ... | ... | ... |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Changelog
|
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
|
||||||
|------|--------|---------|
|
|
||||||
| 2026-05-01 | 95df17bf | Initial documentation and build configuration |
|
|
||||||
| 2026-05-01 | c3b0c0f5 | Updated Caddy labels for reverse proxying |
|
|
||||||
| 2026-02-10 | e6ffa042 | Fixed bug in Postgres database connection |
|
|
||||||
| 2026-01-26 | 361a325b | Added environment variables for Wiki.js configuration |
|
|
||||||
| 2026-01-25 | 5fc017f4 | Updated Docker stack deployment script |
|
|
||||||
|
|
||||||
<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:36:07.591Z
|
|
||||||
- Source: swarm/wiki.yaml
|
|
||||||
- Review User Guide and Changelog sections
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue