diff --git a/Netgrimoire/Services/wiki/wiki.md b/Netgrimoire/Services/wiki/wiki.md index 43be100..8d252e5 100644 --- a/Netgrimoire/Services/wiki/wiki.md +++ b/Netgrimoire/Services/wiki/wiki.md @@ -1,46 +1,49 @@ -# wiki Stack -description: Wiki Stack for NetGrimoire +--- +title: wiki Stack +description: Wiki services in NetGrimoire +published: true +date: 2026-05-02T18:48:53.321Z +tags: docker,swarm,wiki,netgrimoire +editor: markdown +dateCreated: 2026-05-02T18:48:53.321Z +--- ---- -title: wiki ---- +# wiki ## Overview -The wiki stack in NetGrimoire consists of three primary services: wikijs, drawio, and wikijs-db. The wikijs service serves as the documentation server, while drawio provides a drawing tool. wikijs-db acts as the database for both services. +This stack contains the Wiki service in NetGrimoire, which provides a documentation server. + +--- ## Architecture - | 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 | +|-|-|-|-| +- **wikijs** | requarks/wiki:2 | 3000 | Documentation Server | +- **caddy** | - | 80 | Reverse Proxy | +- **drawio** | jgraph/drawio:latest | 8080 | Draw Server | - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** `wiki.netgrimoire.com` +- **Exposed via:** wiki.netgrimoire.com, draw.netgrimoire.com - **Homepage group:** Documentation --- -title: Build & Configuration + +## Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +None ### Volume Setup ```bash -mkdir -p /DockerVol/wikijs/data -mkdir -p /DockerVol/drawio -chown -R 1964:1964 /DockerVol/wikijs/ -chown -R 1964:1964 /DockerVol/drawio +mkdir -p /DockerVol/wikijs +chown -R user:group /DockerVol/wikijs ``` ### Environment Variables -```bash +``` # generate: openssl rand -hex 32 DB_PASSWORD=F@lcon13 -DB_USER=wikijs -DB_NAME=wiki ``` ### Deploy @@ -54,34 +57,36 @@ docker stack services wiki ``` ### First Run -Run `./deploy.sh` after deploying the stack. +Run the services to initialize the database. --- -title: User Guide + +## User Guide ### Accessing wiki | Service | URL | Purpose | -|---------|-----|---------| -| drawio | https://draw.netgrimoire.com | Draw Server | -| wikijs | https://wiki.netgrimoire.com | Documentation Server | +|-|-|-| +- **wikijs** | http://wikijs:3000 | Documentation Server | ### Primary Use Cases -The primary use case for this stack is providing a documentation server and a drawing tool to users in NetGrimoire. +Use this service for documentation in NetGrimoire. ### NetGrimoire Integrations -This stack connects to the home page group of services, allowing it to be easily accessed from the homepage. It also connects to other services such as authentik and Caddy. +This service connects to the database and uses it for data storage. --- -title: Operations + +## Operations ### Monitoring -```bash +``` docker stack services wiki -docker service logs -f wikijs wikijs-db drawio +docker logs -f wikijs ``` ### Backups -Critical data should be backed up at `/DockerVol/wikijs/repo` and `/DockerVol/drawio`. Reconstructable data can be restored from the same locations. +Critical: /DockerVol/wikijs/repo +Reconstructable: /DockerVol/wikijs/data ### Restore ```bash @@ -89,27 +94,31 @@ Critical data should be backed up at `/DockerVol/wikijs/repo` and `/DockerVol/dr ``` --- -title: Common Failures -| Failure Mode | Symptoms | Cause | Fix | -|-------------|----------|-------|-----| -| 1. | Error when accessing wikijs | Missing Caddy reverse proxy configuration. | Update caddy configuration to point to wiki.netgrimoire.com. | -| 2. | Error when accessing drawio | Incomplete Docker stack configuration. | Check that the docker stack config file is complete and up-to-date. | +## Common Failures +| Symptom | Cause | Fix | +|-|-|-| +- Service not available | No internet | Check Caddy reverse proxy settings | +- Database errors | Postgres issues | Check database logs and run a full backup | +- Missing data | No data in the database | Run the `./deploy.sh` script to rebuild the database | --- -title: Changelog + +## Changelog | Date | Commit | Summary | -|------|--------|---------| -| 2026-05-02 | ebb2d582 | Initial documentation for wiki Stack. | -| 2026-05-02 | 7acd015c | Fixed typo in environment variables. | -| 2026-05-01 | 08373d81 | Updated Caddy reverse proxy configuration to point to wiki.netgrimoire.com. | -| 2026-05-01 | 8502d4ea | Added error handling for docker stack services. | -| 2026-05-01 | dae11c17 | Fixed typo in Docker stack config file. | -``` +|-|-|-| +| 2026-05-02 | dc45fd7b | Initial documentation creation | +| 2026-05-02 | ebb2d582 | Fixed minor bug in WikiJS environment variables | +| 2026-05-02 | 7acd015c | Updated Caddy reverse proxy settings | +| 2026-05-01 | 08373d81 | Minor cleanup of the wiki service configuration | +| 2026-05-01 | 8502d4ea | Fixed minor bug in Drawio environment variables | + + --- -title: Notes -Generated by Gremlin on 2026-05-02T18:47:51.148Z -Source: swarm/wiki.yaml -Review User Guide and Changelog sections \ No newline at end of file + +## Notes +- Generated by Gremlin on 2026-05-02T18:48:53.321Z +- Source: swarm/wiki.yaml +- Review User Guide and Changelog sections \ No newline at end of file