Legacy Wiki.js dev environment setup checklist (new machine)
Legacy notes for the old Wiki.js deployment, kept for reference after the wiki migration to llm-wiki/.
Prerequisites
- Docker and Docker Compose installed.
- SSH access to production: you must be able to
ssh r26d@buckyverse.org(see ssh-keys-audit.md if needed).
Steps
1. Go to the Wiki.js dev directory
cd /path/to/buckyverse.org/dev/wikijs
2. Create and edit .env
cp .env.example .env
Edit dev/wikijs/.env. Required:
| Variable | Value | Notes |
|---|---|---|
PROD_SSH |
r26d@buckyverse.org |
Required for pull/push scripts. |
Optional (set if needed):
| Variable | When to set |
|---|---|
PROD_SSH_KEY |
If you use a non-default SSH key for this host (e.g. ~/.ssh/id_rsa_r26d_2048). |
PROD_DB_USER |
Default is wiki (prod Postgres user). Only change if prod differs. |
PROD_COMPOSE_DIR |
Only if you want push-to-prod.sh --switch to update prod from this machine (e.g. /home/r26d/wiki). |
PROD_WIKI_VOLUME |
Only for --data sync (uploads/cache). Value: e061d18871d73252bbef2d76f92ecd83933c39c7b99aca43a48bfb8431059fec. |
PROD_DUMP_EXCLUDE_TABLE_DATA |
Leave default to exclude assetData from dumps (avoids connection drops). Set empty to include. |
WIKIJS_API_TOKEN |
For scripts that call the Wiki.js API (e.g. delete-page-by-path). Get from Admin → API Access. |
WIKI_NODE_MAX_OLD_SPACE_SIZE |
Increase (e.g. 8192) for large GraphQL imports (e.g. full Synergetics Dictionary). |
3. Start the local stack
docker compose up -d
Open http://localhost:3000 and complete the Wiki.js setup wizard once (this DB will be replaced when you pull from prod).
4. Make scripts executable and pull production
chmod +x scripts/pull-from-prod.sh scripts/push-to-prod.sh
./scripts/pull-from-prod.sh
Reload http://localhost:3000 — you should see production content.
Configs you might be missing
.env— If you only copied the repo, you don’t havedev/wikijs/.env(it’s gitignored). Create it from.env.exampleand set at leastPROD_SSH.- SSH key — This machine must have an SSH key that’s authorized for
r26d@buckyverse.org. If you use a specific key, setPROD_SSH_KEYin.env. - Docker — Docker and Docker Compose must be installed and running so
docker compose up -dand the pull script work.
Daily workflow
- Refresh from prod:
./scripts/pull-from-prod.sh - Edit locally: http://localhost:3000
- Push to prod:
./scripts/push-to-prod.sh(creates a new DB on prod; see wikijs-push-rollback.md)
Full docs
- wikijs-local-dev.md — Full guide and troubleshooting.
- dev/wikijs/README.md — Quick start in repo.