This guide is a quick and simple guide to run Wiki.js on your local macOS or Windows machine.
Install Docker Desktop which includes both Docker and Docker Compose:
Create a new folder named wiki
at the location of your choice.
Inside this folder, create a new file named docker-compose.yaml
and paste the following contents inside:
version: "3"
services:
db:
image: postgres:15-alpine
environment:
POSTGRES_DB: wiki
POSTGRES_PASSWORD: wikijsrocks
POSTGRES_USER: wikijs
logging:
driver: "none"
restart: unless-stopped
volumes:
- db-data:/var/lib/postgresql/data
wiki:
image: ghcr.io/requarks/wiki:2
depends_on:
- db
environment:
DB_TYPE: postgres
DB_HOST: db
DB_PORT: 5432
DB_USER: wikijs
DB_PASS: wikijsrocks
DB_NAME: wiki
restart: unless-stopped
ports:
- "80:3000"
volumes:
db-data:
This file simply defines a PostgreSQL container (our database) and the Wiki.js container.
On macOS, launch Terminal and navigate to the wiki
folder you created earlier.
On Windows, open the folder wiki
you created earlier in File Explorer.
In the address bar, type cmd
and press ENTER to launch a Command Prompt at that location.
Type the following command in the Terminal / Command Prompt to start Wiki.js:
docker compose up -d
Open your browser and navigate to http://localhost to complete the installation and use Wiki.js!