How to Self-Host Wiki.js Modern Wiki Platform

What Is Wiki.js?

Wiki.js is a powerful, modern wiki engine built on Node.js. It features a beautiful interface, supports multiple editors (Markdown, visual, and raw HTML), and includes built-in authentication, search, and Git-based storage. It is one of the most feature-rich open-source wiki platforms available.

Prerequisites

• A Breeze with at least 2 GB RAM running Ubuntu 22.04+
• Docker and Docker Compose installed
• A domain name pointed to your Breeze

Docker Compose Setup

mkdir -p ~/wikijs && cd ~/wikijs

version: "3.8"
services:
  wikijs:
    image: ghcr.io/requarks/wiki:2
    container_name: wikijs
    restart: unless-stopped
    ports:
      - "3000:3000"
    environment:
      - DB_TYPE=postgres
      - DB_HOST=wikijs-db
      - DB_PORT=5432
      - DB_USER=wikijs
      - DB_PASS=WikiDbPass123
      - DB_NAME=wikijs
    depends_on:
      - wikijs-db

  wikijs-db:
    image: postgres:16-alpine
    container_name: wikijs-db
    restart: unless-stopped
    volumes:
      - wikijs_db:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=wikijs
      - POSTGRES_USER=wikijs
      - POSTGRES_PASSWORD=WikiDbPass123

volumes:
  wikijs_db:

Launch and Configure

docker compose up -d

Open http://your-breeze-ip:3000 to access the setup wizard. Create your admin account, configure the site URL, and select a default editor. Wiki.js is now ready for content creation.

Notable Features

• Full-text search powered by the database or Elasticsearch
• Git sync to back up all content to a remote repository automatically
• Granular permissions with groups and page-level access rules
• Multiple authentication modules including OAuth2, SAML, and LDAP
• Built-in diagramming with draw.io and Mermaid support