Skip to content

Latest commit

 

History

History
194 lines (138 loc) · 7.4 KB

docker.md

File metadata and controls

194 lines (138 loc) · 7.4 KB
Raw
title description published date tags editor dateCreated
Docker
Getting started with the Docker image
true
2022-02-11 22:48:39 UTC
setup, docker
markdown
2019-02-15 04:23:08 UTC

Before proceeding, make sure you meet the system requirements. {.is-info}

Using the Docker image

Wiki.js is published as a Docker image on GitHub Packages as ghcr.io/requarks/wiki and on Docker Hub as requarks/wiki.

It's highly recommended that you don't use the latest tag but instead the major version you need, e.g. ghcr.io/requarks/wiki:2

It's also possible to point to a specific minor version (e.g. ghcr.io/requarks/wiki:2.5), although you will not automatically get the latest features when pulling the latest image. {.is-info}

Environment Variables

You must set the following environment variables. They are all required unless specified otherwise.

Database

  • DB_TYPE : Type of database (mysql, postgres, mariadb, mssql or sqlite) {.grid-list}

For PostgreSQL, MySQL, MariaDB and MSSQL only:

  • DB_HOST : Hostname or IP of the database
  • DB_PORT : Port of the database
  • DB_USER : Username to connect to the database
  • DB_PASS : Password to connect to the database
  • DB_NAME : Database name {.grid-list}

When connecting to a database server with SSL enforced:

  • DB_SSL : Set to either 1 or true to enable. (optional, off if omitted)
  • DB_SSL_CA : Database CA certificate content, as a single line string (without spaces or new lines), without the prefix and suffix lines. (optional, requires 2.3+) {.grid-list}

Alternative way to provide the database password, via a local file secret:

  • DB_PASS_FILE: Path to the mapped file containing to the database password. (optional, replaces DB_PASS) {.grid-list}

For SQLite only:

  • DB_FILEPATH : Path to the SQLite file {.grid-list}

HTTPS

This feature is only available from version 2.1 and up {.is-info}

Environment variables are provided for easy Let's Encrypt configuration. If you want to provide your own SSL certificate configuration, you must instead mount a config file as explained below.

  • SSL_ACTIVE : Set to either 1 or true to enable. (optional, off if omitted)
  • LETSENCRYPT_DOMAIN : The domain / sub-domain to use when requesting a certificate from Let's Encrypt (e.g. wiki.example.com)
  • LETSENCRYPT_EMAIL : The administrator email used when requesting a certificate from Let's Encrypt. {.grid-list}

The exposed HTTPS port is 3443. Both HTTP and HTTPS ports must be exposed when using Let's Encrypt.

The HTTP port must be accessible from the internet for the certificate provisioning to complete! Once the certificate is generated, you can enable automatic HTTPS redirection from the Administration area, under the SSL section.

Note that you must leave the HTTP port open and accessible at all times for the certificate renewal process to work. This is NOT a security risk when the above option (HTTPS Redirection) is enabled. {.is-warning}

High-Availability

This feature is only available from version 2.3 and up {.is-info}

When running Wiki.js with multiple replicas (e.g. Kubernetes cluster / Docker Swarm), you must enable High-Availability to ensure any change is propagated to other instances.

  • HA_ACTIVE : Set to either 1 or true to enable. (optional, off if omitted) {.grid-list}

You must be using a PostgreSQL database in order to enable this feature. It will not work with any other database engine! {.is-warning}

Examples

Here's an example of a command to run Wiki.js connecting to a PostgreSQL database:

docker run -d -p 8080:3000 --name wiki --restart unless-stopped -e "DB_TYPE=postgres" -e "DB_HOST=db" -e "DB_PORT=5432" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2

or to a MySQL database:

docker run -d -p 8080:3000 --name wiki --restart unless-stopped -e "DB_TYPE=mysql" -e "DB_HOST=db" -e "DB_PORT=3306" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2

Both examples assume you have a database running in another container named db on the same network. Wiki.js does NOT come with a database engine. See the requirements for more details. {.is-warning}

Let's Encrypt example:

docker run -d -p 80:3000 -p 443:3443 -e "LETSENCRYPT_DOMAIN=wiki.example.com" -e "[email protected]" --name wiki --restart unless-stopped -e "DB_TYPE=postgres" -e "DB_HOST=db" -e "DB_PORT=5432" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2

Alternative: Mount the config file

If using environment variables is not your cup of tea, you can also mount a config file instead.

Create a new file based on the sample config file and modify the values to match your setup. You can then mount the config file in the container:

docker run -d -p 8080:3000 --name wiki --restart unless-stopped -v YOUR-FILE.yml:/wiki/config.yml ghcr.io/requarks/wiki:2

It's also possible to define an alternate location for the config file to be loaded from, using the CONFIG_FILE env variable. This is useful in scenarios where you want to mount a configuration folder instead.

  • CONFIG_FILE : Path to the config.yml file {.grid-list}

Change User Mode

By default, Wiki.js runs as user wiki. If you get permissions issues while mounting files (such as SQLite db or private keys), you can override the runtime user to run as root using the -u parameter, e.g.:

docker run -d -p 8080:3000 -u="root" --name wiki --restart unless-stopped -e "DB_TYPE=postgres" -e "DB_HOST=db" -e "DB_PORT=5432" -e "DB_USER=wikijs" -e "DB_PASS=wikijsrocks" -e "DB_NAME=wiki" ghcr.io/requarks/wiki:2

This is however not a secure way to run containers. Make sure you understand the security implications before doing so.

Using Docker Compose

Here's a full example of a Docker Compose file for Wiki.js, using PostgreSQL, listening on port 80:

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:

{.align-abstopright}

ARM images

Since version 2.4, ARMv7 and ARM64 images are part of the same docker image tags as AMD64. Simply use the same tags as above. {.is-info}

This image is compatible with:

  • ARM64: Raspberry Pi 4, 3 and later Raspberry Pi 2 (v1.2)
  • ARMv7: Early Raspberry Pi 2 (v1.1)

The original, first-generation Raspberry Pi is not supported (ARMv6).

OpenShift

An example OpenShift-compatible Dockerfile is available here.