Self-host Wiki.js on a VPS

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

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

Specification

Status
Listed
Category
Productivity
Services
db, wiki
Ports
3000
Volumes
1
Memory
about 512 MiB
arm64
image published
amd64
image published
Settings to fill in
none

About Wiki.js

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

What it deploys

Wiki.js runs as 2 services in a single Compose app, listening on port 3000, with 1 named volume mount.

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

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.

Settings and environment

You do not have to fill in anything. 2 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
dbPOSTGRES_DBPreset by the template
dbPOSTGRES_PASSWORDGenerated at deploy
dbPOSTGRES_USERPreset by the template
wikiDB_HOSTPreset by the template
wikiDB_NAMEPreset by the template
wikiDB_PASSGenerated at deploy
wikiDB_PORTPreset by the template
wikiDB_TYPEPreset by the template
wikiDB_USERPreset by the template

Install Wiki.js on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get wikijs
  4. Install it

    This template has an install form, so the CLI fills each setting from --env, a generated secret or its default.

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

    To put a service behind a domain at install, add --domain SERVICE=HOST:

    levelrail-cli templates install wikijs --name my-wikijs --domain db=wikijs.example.com

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Wiki.js.

More in Productivity

All Productivity templates