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.


Modern wiki app built on Node.js
Add your server credentials to Server Compass
Choose from our template library
Fill in settings and click Deploy
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.
Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

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

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

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

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

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

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.

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

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 Wiki.js app loaded successfully in a browser and displayed the setup wizard.
It deploys Wiki.js 2 with a PostgreSQL 16 database and a persistent database volume.
The tutorial used host port 3000, which maps to the Wiki.js web server on container port 3000.
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.
No. The deployment guide should live on the Wiki.js template detail page and be linked from the reusable template deployment docs page.
Want full control? Here's how to deploy Wiki.js yourself using Docker Compose.
Use your terminal to securely access your server. You'll need your server's IP address.
# Connect via SSH
ssh root@your-vps-ip
# Alternative with key file
ssh -i /path/to/key root@your-vps-ipFirst time? Make sure Docker is installed on your VPS. Run: curl -fsSL https://get.docker.com | sh
Initialize a project folder on your server.
# Create and navigate to project directory
mkdir -p ~/apps/wikijs
cd ~/apps/wikijsUse this Docker Compose configuration for your deployment:
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:
PORTHost port(default: 3000)DB_PASSWORDDB passwordBring up your containers in detached mode.
# Start all services
docker compose up -d
# List running containers
docker compose ps
# Watch the logs
docker compose logs -fAllow the application port through your server's firewall.
# Allow the application port through firewall
sudo ufw allow 3000/tcp
sudo ufw reload
# Access your app at:
# http://your-server-ip:3000Skip the terminal and deploy Wiki.js with a visual interface. Configure everything with clicks, not commands.
After deploying Wiki.js with Server Compass, complete these steps to finish setup
Complete setup wizard
Create admin account
Configure categories
Need help? Check out our documentation for detailed guides.
Common questions about self-hosting Wiki.js
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.
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.
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Wiki.js backup and restore procedures.
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.
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.
Download Server Compass and deploy Wiki.js to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass