Self-host Wiki.js with Levelrail

A modern wiki with Markdown and visual editing, page permissions and full-text search, backed by Postgres.

  • Authorrequarks
  • LicenceAGPL-3.0
  • Memory512 MiB
  • Archarm64
  • Services2

How to self-host Wiki.js

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • postgres:16-alpine
    • ghcr.io/requarks/wiki:2
  2. Create the app

    2 services start in a single Compose app, with 1 named volume mount for your data, on port 3000.

  3. Fill in the secrets

    2 secrets are generated and stored encrypted, 7 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Wiki.js requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 image published
Ports
3000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0, network copyleft (agpl) license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Wiki.js. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Wiki.js docs page.

Deploy Wiki.js your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Wiki.js from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain db=app.example.com.

levelrail-cli templates install wikijs --name my-wikijs

Deploy Wiki.js with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/wikijs/install \
  -d '{
    "name": "my-wikijs"
  }'

Wiki.js configuration

Wiki.js services

ServiceImagePortsVolumes
db postgres:16-alpine none pgdata -> /var/lib/postgresql/data
wiki ghcr.io/requarks/wiki:2 3000 none

Wiki.js environment variables

VariableServiceValue
POSTGRES_DB db Preset by the template
POSTGRES_PASSWORD db Generated at deploy
POSTGRES_USER db Preset by the template
DB_HOST wiki Preset by the template
DB_NAME wiki Preset by the template
DB_PASS wiki Generated at deploy
DB_PORT wiki Preset by the template
DB_TYPE wiki Preset by the template
Show all 9 variables
  • DB_USERwikiPreset by the template

Ports and volumes

Ports
3000
Volumes
1 named mount: pgdata -> /var/lib/postgresql/data

Wiki.js FAQ

How much memory does Wiki.js need?

The catalog lists about 512 MiB of memory for Wiki.js across its 2 services.

Does Wiki.js run on arm64?

For Wiki.js, an arm64 image is published; amd64 is image published.

What licence is Wiki.js under?

Wiki.js is licensed under AGPL-3.0, which is network copyleft, so source sharing also applies when it is offered as a hosted service.

Does Wiki.js need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does Wiki.js bundle?

The template includes Postgres, running as its own service.

Which ports does Wiki.js use?

Wiki.js listens on port 3000 inside the stack.

Where does Wiki.js keep its data?

In a named volume: pgdata mounted at /var/lib/postgresql/data.

Can I deploy Wiki.js on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id wikijs for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image postgres:16-alpine, ghcr.io/requarks/wiki:2 is what you deploy there.

levelrail-cli templates install wikijs --name my-wikijs