What is DokuWiki?

DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite

https://www.dokuwiki.org/

TL;DR;

Docker Compose

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-dokuwiki/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Why use Bitnami Images?

Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
With Bitnami images the latest bug fixes and features are available as soon as possible.
Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
Bitnami images are built on CircleCI and automatically pushed to the Docker Hub.
All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.

Prerequisites

To run this application you need Docker Engine 1.10.0. Docker Compose is recomended with a version 1.6.0 or later.

How to use this image

Run the application using Docker Compose

This is the recommended way to run Dokuwiki. You can use the following docker compose template:

version: '2'
services:
  dokuwiki:
    image: 'bitnami/dokuwiki:latest'
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - 'dokuwiki_data:/bitnami'
volumes:
  dokuwiki_data:
    driver: local

Run the application manually

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

Create a new network for the application :

$ docker network create dokuwiki-tier

Run the Dokuwiki container:

$ docker run -d \
  -p 80:80 -p 443:443 --name dokuwiki --net dokuwiki-tier \
  bitnami/dokuwiki:latest

Then you can access your application at http://your-ip/

Persisting your application

If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a volume at the /bitnami path. The above examples define a docker volume namely dokuwiki_data. The DokuWiki application state will persist as long as this volume is not removed.

To avoid inadvertent removal of this volume you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount persistent folders in the host using docker-compose

This requires a sightly modification from the template previously shown:

version: '2'

services:
  dokuwiki:
    image: 'bitnami/dokuwiki:latest'
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - '/path/to/dokuwiki-persistence:/bitnami'

Mount persistent folders manually

In this case you need to specify the directories to mount on the run command. The process is the same than the one previously shown:

If you haven't done this before, create a new network for the application :

$ docker network create dokuwiki-tier

Run the Dokuwiki container:

$ docker run -d -p 80:80 -p 443:443 --name dokuwiki \
  --net dokuwiki-tier \
  --volume /path/to/dokuwiki-persistence:/bitnami \
  bitnami/dokuwiki:latest

Upgrade this application

Bitnami provides up-to-date versions of Dokuwiki, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Dokuwiki container.

Get the updated images:

$ docker pull bitnami/dokuwiki:latest

Stop your container

For docker-compose: $ docker-compose stop dokuwiki
For manual execution: $ docker stop dokuwiki

Take a snapshot of the application state

$ rsync -a /path/to/dokuwiki-persistence /path/to/dokuwiki-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

You can use this snapshot to restore the application state should the upgrade fail.

Remove the stopped container

For docker-compose: $ docker-compose rm -v dokuwiki
For manual execution: $ docker rm -v dokuwiki

Run the new image

For docker-compose: $ docker-compose start dokuwiki
For manual execution (mount the directories if needed): docker run --name dokuwiki bitnami/dokuwiki:latest

Configuration

Environment variables

When you start the DokuWiki image, you can adjust the configuration of the instance by passing one or more environment variables either on the docker-compose file or on the docker run command line. If you want to add a new environment variable:

For docker-compose add the variable name and value under the application section:

dokuwiki:
  image: bitnami/dokuwiki:latest
  ports:
    - 80:80
    - 443:443
  environment:
    - DOKUWIKI_PASSWORD=my_password

For manual execution add a -e option with each variable and value:

$ docker run -d -p 80:80 -p 443:443 --name dokuwiki \
  -e DOKUWIKI_PASSWORD=my_password \
  --net dokuwiki-tier \
  --volume /path/to/dokuwiki-persistence:/bitnami/dokuwiki \
  bitnami/dokuwiki:latest

Available variables:

DOKUWIKI_USERNAME: Dokuwiki application SuperUser name. Default: superuser
DOKUWIKI_FULL_NAME: Dokuwiki SuperUser Full Name. Default: Full Name
DOKUWIKI_PASSWORD: Dokuwiki application password. Default: bitnami1
DOKUWIKI_EMAIL: Dokuwiki application email. Default: user@example.com
DOKUWIKI_WIKI_NAME: Dokuwiki wiki name. Default: Bitnami DokuWiki

Notable Changes

0.20170219.201708232029-r3

Custom smileys, available in lib/images/smileys/local, are now persisted.
Address issue #40.
In order to upgrade your image from previous versions, see the workaround provided on issue #42.

0.20180422.201805030840-r5

Custom InterWiki shortcut icons, available in lib/images/interwiki/, are now persisted.
Address issue #40.
In order to upgrade your image from previous versions, see the workaround provided on issue #42.

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

Host OS and version
Docker version ($ docker version)
Output of $ docker info
Version of this container ($ echo $BITNAMI_APP_VERSION inside the container)
The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

benortiz/dokuwiki