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
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