Back to all templates
Wiki.js logo

Wiki.js

Application512MB+ RAM

Modern wiki app built on Node.js

wikidocumentationnodejs

Deploy Wiki.js in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Wiki.js

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Wiki.js on a VPS with Server Compass

Use the Wiki.js template in Server Compass to deploy a self-hosted modern wiki engine with markdown support on your VPS, then verify the Wiki.js setup wizard in a browser.

About 7 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a Wiki.js app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for Wiki.js

Use the template picker search to find Wiki.js in the Server Compass template catalog.

Searching for Wiki.js in the Server Compass template picker
4
Step 4

Select the Wiki.js template

Choose the Wiki.js template. Server Compass fills the Wiki.js image, PostgreSQL service, database settings, and required secret value.

Wiki.js template selected in Server Compass
5
Step 5

Review the Wiki.js settings

Confirm the app name and compose services. In this run, the app was named wikijs-demo and used host port 3000.

Reviewing Wiki.js project settings and compose services
6
Step 6

Deploy Wiki.js

Review the generated environment values, keep the database password masked, confirm the port is available, and click Deploy Now.

Reviewing Wiki.js environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Wiki.js and PostgreSQL images, starts the containers, and verifies the stack.

Server Compass deploying the Wiki.js template on the VPS
8
Step 8

Confirm Wiki.js is running

After deployment finishes, return to the Apps tab and confirm the Wiki.js app is marked Running with its application URL available.

Wiki.js template running in the Server Compass Apps tab
9
Step 9

Open Wiki.js in the browser

Click Open Application or open the application URL in a browser. The Wiki.js setup wizard confirms the deployed app is reachable and ready for the database credentials.

The deployed Wiki.js setup wizard loaded in a browser

After Wiki.js Opens

  • Complete the Wiki.js setup wizard with the generated PostgreSQL password from Server Compass.
  • Keep the database password masked in screenshots and docs.
  • Add a domain and HTTPS before inviting users or publishing content publicly.
  • Create roles and permissions before publishing editorial workflows.
  • Back up the PostgreSQL data volume before storing production documentation.

Verified Result

The Wiki.js app loaded successfully in a browser and displayed the setup wizard.

Wiki.js deployment questions

What does the Wiki.js template deploy?

It deploys Wiki.js 2 with a PostgreSQL 16 database and a persistent database volume.

Which port did the tutorial use?

The tutorial used host port 3000, which maps to the Wiki.js web server on container port 3000.

Why does the browser verification stop at the setup wizard?

A fresh Wiki.js deployment is considered reachable when the setup wizard loads. Continuing further would require entering generated database credentials, so the public guide verifies the safe pre-setup wizard.

Should this become a blog post?

No. The deployment guide should live on the Wiki.js template detail page and be linked from the reusable template deployment docs page.

CLI Deployment

Deploy Wiki.js Yourself

Want full control? Here's how to deploy Wiki.js yourself using Docker Compose.

1

Access Your VPS Terminal

Use your terminal to securely access your server. You'll need your server's IP address.

terminal
# Connect via SSH
ssh root@your-vps-ip

# Alternative with key file
ssh -i /path/to/key root@your-vps-ip

First time? Make sure Docker is installed on your VPS. Run: curl -fsSL https://get.docker.com | sh

2

Set Up the Deployment Folder

Initialize a project folder on your server.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/wikijs
cd ~/apps/wikijs
3

Set Up the Stack Definition

Use this Docker Compose configuration for your deployment:

docker-compose.yml
services:
  wikijs:
    image: ghcr.io/requarks/wiki:2
    ports:
      - "3000:3000"
    environment:
      - DB_TYPE=postgres
      - DB_HOST=db
      - DB_PORT=5432
      - DB_USER=wikijs
      - DB_PASS=<your-db-password>
      - DB_NAME=wikijs
    restart: unless-stopped
    depends_on:
      db:
        condition: service_healthy

  db:
    image: postgres:16-alpine
    environment:
      - POSTGRES_USER=wikijs
      - POSTGRES_PASSWORD=<your-db-password>
      - POSTGRES_DB=wikijs
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U wikijs"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  postgres_data:
Required Settings
PORTHost port(default: 3000)
DB_PASSWORDDB password
4

Start the Containers

Bring up your containers in detached mode.

terminal
# Start all services
docker compose up -d

# List running containers
docker compose ps

# Watch the logs
docker compose logs -f
5

Set Up Firewall Rules

Allow the application port through your server's firewall.

terminal
# Allow the application port through firewall
sudo ufw allow 3000/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:3000
Skip the Terminal

Let Server Compass do the heavy lifting.

Skip the terminal and deploy Wiki.js with a visual interface. Configure everything with clicks, not commands.

  • Beautiful interface
  • One-click deploys
  • Let's Encrypt SSL
  • Zero downtime
  • Container monitoring
  • Easy rollbacks
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying Wiki.js with Server Compass, complete these steps to finish setup

1

Complete setup wizard

2

Create admin account

3

Configure categories

Need help? Check out our documentation for detailed guides.

Wiki.js FAQ

Common questions about self-hosting Wiki.js

How do I deploy Wiki.js with Server Compass?

Simply download Server Compass, connect to your VPS, and select Wiki.js from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Wiki.js?

Wiki.js requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Wiki.js data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Wiki.js backup and restore procedures.

How do I update Wiki.js to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Wiki.js image will be pulled and deployed with zero downtime.

Is Wiki.js free to self-host?

Wiki.js is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host Wiki.js?

Download Server Compass and deploy Wiki.js to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass