248 lines
9.8 KiB
Markdown
248 lines
9.8 KiB
Markdown
|
|
# 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
|
|
|
|
```bash
|
|
$ 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.
|
|
* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.
|
|
* Bitnami container images are released daily with the latest distribution packages available.
|
|
|
|
|
|
> This [CVE scan report](https://quay.io/repository/bitnami/dokuwiki?tab=tags) contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page.
|
|
|
|
# How to deploy DokuWiki in Kubernetes?
|
|
|
|
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami DokuWiki Chart GitHub repository](https://github.com/bitnami/charts/tree/master/upstreamed/dokuwiki).
|
|
|
|
Bitnami containers can be used with [Kubeapps](https://kubeapps.com/) for deployment and management of Helm Charts in clusters.
|
|
|
|
# Supported tags and respective `Dockerfile` links
|
|
|
|
> NOTE: Debian 8 images have been deprecated in favor of Debian 9 images. Bitnami will not longer publish new Docker images based on Debian 8.
|
|
|
|
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/).
|
|
|
|
|
|
* [`0-ol-7`, `0.20180422.201901061035-ol-7-r59` (0/ol-7/Dockerfile)](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/0.20180422.201901061035-ol-7-r59/0/ol-7/Dockerfile)
|
|
* [`0-debian-9`, `0.20180422.201901061035-debian-9-r52`, `0`, `0.20180422.201901061035`, `0.20180422.201901061035-r52`, `latest` (0/debian-9/Dockerfile)](https://github.com/bitnami/bitnami-docker-dokuwiki/blob/0.20180422.201901061035-debian-9-r52/0/debian-9/Dockerfile)
|
|
|
|
Subscribe to project updates by watching the [bitnami/dokuwiki GitHub repo](https://github.com/bitnami/bitnami-docker-dokuwiki).
|
|
|
|
|
|
# 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:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
1. Create a new network for the application :
|
|
|
|
```bash
|
|
$ docker network create dokuwiki-tier
|
|
```
|
|
|
|
2. Run the Dokuwiki container:
|
|
|
|
```bash
|
|
$ 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](https://docs.docker.com/engine/tutorials/dockervolumes/). 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:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
1. If you haven't done this before, create a new network for the application :
|
|
|
|
```bash
|
|
$ docker network create dokuwiki-tier
|
|
```
|
|
|
|
2. Run the Dokuwiki container:
|
|
|
|
```bash
|
|
$ 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.
|
|
|
|
1. Get the updated images:
|
|
|
|
```bash
|
|
$ docker pull bitnami/dokuwiki:latest
|
|
```
|
|
|
|
2. Stop your container
|
|
|
|
* For docker-compose: `$ docker-compose stop dokuwiki`
|
|
* For manual execution: `$ docker stop dokuwiki`
|
|
|
|
3. Take a snapshot of the application state
|
|
|
|
```bash
|
|
$ 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.
|
|
|
|
4. Remove the stopped container
|
|
|
|
* For docker-compose: `$ docker-compose rm -v dokuwiki`
|
|
* For manual execution: `$ docker rm -v dokuwiki`
|
|
|
|
5. Run the new image
|
|
|
|
* For docker-compose: `$ docker-compose up dokuwiki`
|
|
* For manual execution ([mount](#mount-persistent-folders-manually) 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:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```bash
|
|
$ 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](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/40).
|
|
- In order to upgrade your image from previous versions, see the workaround provided on issue [#42](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/42).
|
|
|
|
## 0.20180422.201805030840-r5
|
|
|
|
- Custom InterWiki shortcut icons, available in `lib/images/interwiki/`, are now persisted.
|
|
- Address issue [#40](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/40).
|
|
- In order to upgrade your image from previous versions, see the workaround provided on issue [#42](https://github.com/bitnami/bitnami-docker-dokuwiki/issues/42).
|
|
|
|
# Contributing
|
|
|
|
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-dokuwiki/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-dokuwiki/pulls) with your contribution.
|
|
|
|
# Issues
|
|
|
|
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-dokuwiki/issues). 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
|
|
|
|
Copyright 2016-2019 Bitnami
|
|
|
|
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.
|