Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 2.16 KB

docker-desktop.md

File metadata and controls

85 lines (63 loc) · 2.16 KB
title description published date tags editor dateCreated
Install locally with Docker Desktop
The easiest and quickest way to install Wiki.js on your local machine
true
2022-06-12 21:00:47 UTC
setup, guide
markdown
2022-06-12 21:00:47 UTC

Overview

This guide is a quick and simple guide to run Wiki.js on your local macOS or Windows machine.

Installation

1. Install Docker Desktop

Install Docker Desktop which includes both Docker and Docker Compose:

2. Create the Installation Folder

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:11-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.

3. Open Terminal / Command Prompt

On macOS, launch Terminal and navigate to the wiki folder your 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.

4. Launch Wiki.js

Type the following command in the Terminal / Command Prompt to start Wiki.js:

docker compose up -d

5. Browse to Wiki.js

Open your browser and navigate to http://localhost to complete the installation and use Wiki.js!