dankhostself-host anything

Wiki.js with Docker Compose

Wiki.js is a modern, lightweight and powerful wiki app built on NodeJS. In the project's words: Wiki.js repository README checked 2026-09-25

Runs on: amd64, arm64 from each image's registry manifest, checked 2026-09-25; a CPU counts only if every image has a build for it. Image by image

Add Wiki.js to the builder to use your own domain, get its passwords generated in your browser, and combine it with other apps in one file.

What Wiki.js needs

Only figures Wiki.js's own documentation publishes, each linked to the page it is on. Where the project gives no number, this page does not invent one.

ResourceMinimumRecommended
RAM1 GBnot stated
For Linux; Windows and macOS usually need a bit more. The process itself usually sits around 70 MB, with short bursts during page rendering and indexing. Source: Wiki.js docs: Requirements (CPU, RAM, Storage) checked 2026-09-25
CPU1 core2 cores
Runs fine on a single core; 2 cores or more are recommended to make full use of the background workers. Source: Wiki.js docs: Requirements (CPU, RAM, Storage) checked 2026-09-25
Disknot stated1 GB
At least 1 GB dedicated to Wiki.js is recommended; text-only wikis rarely exceed a few megabytes, uploads add their own size. Source: Wiki.js docs: Requirements (CPU, RAM, Storage) checked 2026-09-25

On top of this, Caddy (the reverse proxy in the file) is a single small container. Wiki.js itself runs as 2 containers: wikijs-db, wikijs-wiki.

Which hardware Wiki.js has images for

Read from each image's manifest list in its registry (anonymous, read-only) when this page was built. An app counts for a CPU only if every one of its images lists it.

  • x86-64 PC or NAS (linux/amd64): every image has a build.
  • Raspberry Pi 4/5, 64-bit OS (linux/arm64): every image has a build.
  • Raspberry Pi 3 or Zero 2 W, 32-bit OS (linux/arm/v7): no image for wiki. No image for this hardware; the builder leaves the app out.
ServiceImagePlatforms in the manifestDigestRegistryChecked
dbpostgres:15-alpineamd64, arm/v6, arm/v7, arm64, 386, ppc64le, riscv64, s390xsha256:f7d23353e1b15400d22ebe31189f4d314b87a4c129cc400c8c2d8d4ca127bf81registry-1.docker.io2026-09-25
wikighcr.io/requarks/wiki:2amd64, arm64sha256:af71a17dc27ccc4c768591b1c504631ed820d9d13d4e8c325be4232c0035638cghcr.io2026-09-25

A manifest says an image exists for a CPU, not how well Wiki.js runs on it: a build for arm64 or arm/v7 can still be too slow or need more memory than the board has. The RAM and disk Wiki.js publishes are in the table above and, for a whole set of apps against a Raspberry Pi, on Will it run on my machine?. A tag like latest can move to a new digest after the date checked.

docker-compose.yml

This is exactly what the builder writes for Wiki.js alone on example.org: the official definition with its published ports removed and Caddy added in front. Every ${VARIABLE} is defined in the .env below.

# docker-compose.yml built at dankhost.com for: Wiki.js
# Each app block is its official compose definition. Only the names were prefixed with
# the app slug (services, containers, volumes, bind folders, .env variables) so any set of
# apps can share one file; other differences are listed under "Changed:" in each block.
# Only Caddy publishes ports. Secrets live in .env next to this file.

services:
  # ---- Caddy: the one reverse proxy, HTTPS certificates from Let's Encrypt ----
  # Source: https://caddyserver.com/docs/running (checked 2026-09-23)
  # Source: https://github.com/dani-garcia/vaultwarden/wiki/Using-Docker-Compose (checked 2026-09-23)
  # Caddyfile goes in ./caddy/Caddyfile. Fixed address 172.30.0.2 so apps can trust it exactly.
  caddy:
    image: "caddy:2"
    container_name: "caddy"
    restart: "unless-stopped"
    ports:
      - "80:80"
      - "443:443"
      - "443:443/udp"
    volumes:
      - "./caddy:/etc/caddy"
      - "caddy-data:/data"
      - "caddy-config:/config"
    networks:
      proxy:
        ipv4_address: "172.30.0.2"

  # ---- Wiki.js (wiki.example.org) ----
  # Source: https://docs.requarks.io/install/docker (checked 2026-09-25)
  # Changed: Removed the '80:3000' port; Caddy reaches wiki:3000 on the proxy network.
  #          The documented database password 'wikijsrocks' is replaced by a generated one, used both as POSTGRES_PASSWORD and DB_PASS.
  wikijs-db:
    image: "postgres:15-alpine"
    container_name: "wikijs-db"
    environment:
      POSTGRES_DB: "wiki"
      POSTGRES_PASSWORD: "${WIKIJS_DB_PASS}"
      POSTGRES_USER: "wikijs"
    logging:
      driver: "none"
    restart: "unless-stopped"
    volumes:
      - "wikijs-db-data:/var/lib/postgresql/data"
    networks:
      wikijs-backend:
        aliases:
          - "db"
  wikijs-wiki:
    image: "ghcr.io/requarks/wiki:2"
    container_name: "wikijs-wiki"
    depends_on:
      - "wikijs-db"
    init: true
    environment:
      DB_TYPE: "postgres"
      DB_HOST: "db"
      DB_PORT: "5432"
      DB_USER: "wikijs"
      DB_PASS: "${WIKIJS_DB_PASS}"
      DB_NAME: "wiki"
    restart: "unless-stopped"
    networks:
      proxy: {}
      wikijs-backend:
        aliases:
          - "wiki"

networks:
  # Pinned so the trusted-proxy address given to each app (172.30.0.2) is exact.
  # If "docker compose up" reports "Pool overlaps", change 172.30.0 here, in Caddy's
  # ipv4_address and in every trusted-proxy value to a free 172.x.0 range.
  proxy:
    ipam:
      config:
        - subnet: "172.30.0.0/24"
          ip_range: "172.30.0.128/25"
          gateway: "172.30.0.1"
  wikijs-backend:
    internal: true

volumes:
  caddy-data:
  caddy-config:
  wikijs-db-data:

Caddyfile save as caddy/Caddyfile

Caddy gets and renews the HTTPS certificate for wiki.example.org by itself once the DNS record points at your server and ports 80 and 443 reach it.

# Caddyfile built at dankhost.com. Save it as ./caddy/Caddyfile next to docker-compose.yml.
# Caddy gets and renews a Let's Encrypt certificate for each name below by itself,
# once the DNS records point at this server and ports 80 and 443 reach it.

# Wiki.js
wiki.example.org {
	reverse_proxy wikijs-wiki:3000
}

Already running nginx, Nginx Proxy Manager, Caddy or Traefik? The reverse-proxy settings Wiki.js needs, for all four, each cited to Wiki.js's own docs.

.env

The secret is left blank here on purpose: a password printed on a public page is the same for everyone who copies it. The builder fills it with random letters and digits made in your browser.

# .env for Wiki.js, from dankhost.com/app/wikijs/. Fill the blank secret before starting.
# Keep this file private (chmod 600).

# Wiki.js
# 32 random letters and digits: the builder fills this in your browser
WIKIJS_DB_PASS=

Changes from the official file

Besides prefixing every service, container, volume, folder and variable with wikijs (so any set of apps can share one file), these are all the differences from what the project documents:

  • Removed the '80:3000' port; Caddy reaches wiki:3000 on the proxy network.
  • The documented database password 'wikijsrocks' is replaced by a generated one, used both as POSTGRES_PASSWORD and DB_PASS.

Notes for Wiki.js behind the proxy

  • Open https://wiki.example.org and finish the setup wizard straight away: it creates the administrator account, and until then anyone who opens the address can. Enter https://wiki.example.org as the Site URL.
  • The documented file turns the database's logs off (logging: driver none); remove those two lines if you need to read them.
  • Wiki.js stores uploaded images and files in the database by default, so the database dump in BACKUP.md covers them.

How to run it

  1. At your DNS provider, add an A record named wiki on your domain pointing at the server's public IP address, and forward TCP 80, TCP 443 and UDP 443 to it.
  2. Save the three files in one folder: docker-compose.yml and .env side by side, the Caddyfile at ./caddy/Caddyfile. Replace example.org with your domain in the Caddyfile, the compose file and the .env, or let the builder do it.
  3. Fill the blank WIKIJS_DB_PASS in .env. The builder generates it; on the server, tr -dc A-Za-z0-9 </dev/urandom | head -c 32 prints 32 random letters and digits. Then chmod 600 .env.
  4. Start it:
    docker compose up -d
    docker compose logs -f caddy   # watch the certificate arrive
  5. Open the new address (wiki. plus your domain) in a browser and follow the notes above.

Back it up

Wiki.js's guide to moving to another server backs up its Docker database with pg_dump in custom format (-F c) and restores it with pg_restore. The wiki container itself stores nothing outside the database.

Below is the BACKUP.md the builder writes next to the compose file above: which of its folders and volumes hold data, the dump command the project documents, rewritten for this file's service names, what to copy with which container stopped, and a restore check. Pick more apps in the builder and it covers them all in one file.

# BACKUP.md built at dankhost.com for: Wiki.js

What to copy from the docker-compose.yml built with this file, the database dump each project documents (rewritten for the service names in that file), what to copy with which container stopped, and how to check the result. Run every command in the folder that holds docker-compose.yml.

The folders are owned by the containers' users: put sudo in front of tar if it says "Permission denied". Named volumes live under /var/lib/docker/volumes, not next to the compose file, so they are copied through a throwaway ubuntu container (Docker's documented --volumes-from method). tar makes a full copy each run; for large folders an incremental tool (restic, borg, rsync) saves time and space.

Never run "docker compose down -v" on this file: it deletes the named volumes of every app in it.

## Before you start

    BACKUP=/mnt/backup/selfhost   # change this: a disk or machine other than this server's system disk
    mkdir -p "$BACKUP"

## Every time: the three stack files

    tar czf "$BACKUP/stack-files.tar.gz" docker-compose.yml .env caddy

.env holds the database passwords and secret keys the apps were set up with; keep this archive as private as the data.

## Caddy (the reverse proxy)

Caddy's docs: 'The data directory must not be treated as a cache.' It holds the TLS certificates and their private keys; without it Caddy has to ask Let's Encrypt for every certificate again.

- caddy-data (named volume, /data in caddy)
  BACK UP: TLS certificates, private keys, OCSP staples.
- caddy-config (named volume, /config in caddy)
  SKIP: the last active configuration, kept for 'caddy run --resume', which this setup does not use: it starts from the Caddyfile.
- ./caddy (/etc/caddy in caddy)
  IN stack-files.tar.gz: the Caddyfile, copied with the stack files above.

Copy (Caddy keeps serving while you copy):

    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu tar cvf /backup/caddy-data.tar /data

Restore check:

    tar tf "$BACKUP/caddy-data.tar" > /dev/null && echo OK
    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu bash -c "cd /data && tar xvf /backup/caddy-data.tar --strip 1"

Sources:
- Caddy docs: Conventions, Data directory: https://caddyserver.com/docs/conventions#data-directory (checked 2026-09-24)
- Docker docs: Volumes, Back up, restore, or migrate data volumes: https://docs.docker.com/engine/storage/volumes/#back-up-restore-or-migrate-data-volumes (checked 2026-09-24)

## Wiki.js

Wiki.js's guide to moving to another server backs up its Docker database with pg_dump in custom format (-F c) and restores it with pg_restore. The wiki container itself stores nothing outside the database.

What this compose mounts:
- wikijs-db-data (named volume, /var/lib/postgresql/data in wikijs-db)
  COVERED BY THE COMMAND BELOW: Postgres data files; copy them only with the database stopped.

1. Database dump for wikijs-db:

    docker compose exec -T wikijs-db pg_dump wiki -U wikijs -F c > "$BACKUP/wikibackup.dump"

   The guide writes docker exec db pg_dump wiki -U wiki -F c > wikibackup.dump. In this compose the database is wiki and its user is wikijs (POSTGRES_DB, POSTGRES_USER), and the service is wikijs-db.

2. Nothing else to copy: the command above holds all of Wiki.js's data. pg_dump is consistent while Wiki.js runs: the dump is a snapshot of the database at the moment it started (PostgreSQL docs).

Restore check:

    docker compose exec -T wikijs-db pg_restore --list < "$BACKUP/wikibackup.dump" > /dev/null && echo OK   # pg_restore can read it

The guide stops Wiki.js, drops and recreates the empty database, and restores into it. With this file's names:

    docker compose stop wikijs-wiki
    docker compose exec -T wikijs-db dropdb -U wikijs wiki
    docker compose exec -T wikijs-db createdb -U wikijs wiki
    docker compose exec -T wikijs-db pg_restore -U wikijs -d wiki < "$BACKUP/wikibackup.dump"
    docker compose start wikijs-wiki

Sources:
- Wiki.js docs: Move to another server (pg_dump / pg_restore of the Docker database): https://docs.requarks.io/install/transfer (checked 2026-09-25)
- PostgreSQL docs: SQL Dump: https://www.postgresql.org/docs/current/backup-dump.html (checked 2026-09-25)

Update it

What docker compose pull does depends only on how each image line in the compose file above is tagged. For Wiki.js as this page writes it:

ServiceImageHow it is pinnedWhat docker compose pull does
caddycaddy:2Major version only (tag 2)Takes the newest image tagged 2: minor and patch releases of 2, never 3. A new major version needs a tag edit.
wikijs-db databasepostgres:15-alpineMajor version only (tag 15-alpine)Takes the newest image tagged 15-alpine: minor and patch releases of 15, never 16. A new major version needs a tag edit.
wikijs-wikighcr.io/requarks/wiki:2Major version only (tag 2)Takes the newest image tagged 2: minor and patch releases of 2, never 3. A new major version needs a tag edit.

Do not raise the major version of wikijs-db by editing its tag. Keep its tag, 15-alpine, as it is when you update Wiki.js.

PostgreSQL's docs: a new major version may change how data is stored on disk, so a data folder written by an older major version will not start under a newer one (the server refuses it). Moving needs a dump and restore (pg_dumpall, then load the dump into the new version) or pg_upgrade. Minor releases of the same major version never change the storage format. Source: PostgreSQL docs: Upgrading a PostgreSQL Cluster checked 2026-09-30

What Wiki.js's docs say about updating

Wiki.js's upgrade page for Docker Compose: docker compose pull for the wiki service, then docker compose up --force-recreate -d.

  • The tag 2 keeps it on Wiki.js 2.

Source: Wiki.js docs: Upgrade (Docker Compose) checked 2026-09-30

The steps

  1. Back up first, as in Back it up above. An update can migrate Wiki.js's data on its first start and its database with it; the copy is the way back.
  2. Download the new images. Running containers are not touched yet:
    docker compose pull
  3. Recreate the containers whose image changed. Volumes and bind-mounted folders stay as they are:
    docker compose up -d
  4. Watch Wiki.js start (Ctrl+C stops following the log, not the app):
    docker compose logs -f wikijs-wiki
  5. Optional: remove the old images the pull left without a tag. This covers every stack on the machine, not only this one:
    docker image prune

Docker's reference for these commands: Docker docs: docker compose pull checked 2026-09-30; Docker docs: docker compose up (recreates changed containers, keeps volumes) checked 2026-09-30; Docker docs: docker image prune checked 2026-09-30

Locked out? Reset the admin password

Overwrites the stored password hash. Wiki.js's docs call the database the only way to change a password without the web UI; the old password cannot be read back.

  1. Make a bcrypt hash of the new password with 12 rounds; the docs say the round count must be 12. Source: Wiki.js docs: Troubleshooting, How to manually reset the admin password? read 2026-10-03
  2. Write it into the users table through the database container. The docs' example connects as wiki to the database wiki; in this file the database user is wikijs and the database is wiki. Source: Wiki.js docs: Troubleshooting, How to manually reset the admin password? read 2026-10-03
    docker compose exec wikijs-db psql -U wikijs -d wiki -c "UPDATE users SET password = '<bcrypt hash>' WHERE email = '<your email>';"

Run the commands in the folder that holds docker-compose.yml. Words in angle brackets are placeholders: replace them, brackets included. docker compose exec runs the command in the container that is already running: Docker docs: docker compose exec read 2026-10-03

Sources

Every page below was fetched on the date shown.

Add Wiki.js to the builder All one hundred apps

Made with AI tools. ยท Privacy