bitnami/dokuwiki
🛑 DEPRECATED Bitnami container image for Dokuwiki
10M+
The DokuWiki container is now deprecated. This image will no longer be released in our catalog, but already-released container images will persist in the registries.
After some months, this repository will be removed in favor of bitnami/dokuwiki-archived where all existing images can be found.
DokuWiki is a standards-compliant wiki optimized for creating documentation. Designed to be simple to use for small organizations, it stores all data in plain text files so no database is required.
Overview of DokuWiki Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
docker run --name dokuwiki bitnami/dokuwiki:latest
You can find the default credentials and available configuration options in the Environment Variables section.
Looking to use DokuWiki in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.
Dockerfile
linksLearn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
You can see the equivalence between the different tags by taking a look at the tags-info.yaml
file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml
.
Subscribe to project updates by watching the bitnami/containers GitHub repo.
The recommended way to get the Bitnami DokuWiki Docker Image is to pull the prebuilt image from the Docker Hub Registry.
docker pull bitnami/dokuwiki:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
docker pull bitnami/dokuwiki:[TAG]
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build
command. Remember to replace the APP
, VERSION
and OPERATING-SYSTEM
path placeholders in the example command below with the correct values.
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
If you remove the container all your data 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 directory at the /bitnami/dokuwiki
path. If the mounted directory is empty, it will be initialized on the first run.
The above examples define the Docker volumes named dokuwiki_data. The DokuWiki application state will persist as long as volumes are not removed.
To avoid inadvertent removal of volumes, you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.
This requires a minor change to the docker-compose.yml
file present in this repository:
dokuwiki:
...
volumes:
- - 'dokuwiki_data:/bitnami/dokuwiki'
+ - /path/to/dokuwiki-persistence:/bitnami/dokuwiki
...
-volumes:
- dokuwiki_data:
- driver: local
NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID
1001
.
Step 1: Create a network (if it does not exist)
docker network create dokuwiki-network
Step 2. Create the DokuWiki container with host volumes
docker run -d --name dokuwiki \
-p 8080:8080 -p 8443:8443 \
--env ALLOW_EMPTY_PASSWORD=yes \
--network dokuwiki-network \
--volume /path/to/dokuwiki-persistence:/bitnami/dokuwiki \
bitnami/dokuwiki:latest
Customizable environment variables
Name | Description | Default Value |
---|---|---|
DOKUWIKI_DATA_TO_PERSIST | Files to persist relative to the DokuWiki installation directory. To provide multiple values, separate them with a whitespace. | data conf lib/plugins lib/tpl lib/images/smileys/local lib/images/interwiki |
DOKUWIKI_USERNAME | DokuWiki superuser username | user |
DOKUWIKI_FULL_NAME | Full Name of the DokuWiki superuser | FirstName LastName |
DOKUWIKI_EMAIL | Email for the application superuser | user@example.com |
DOKUWIKI_PASSWORD | DokuWiki password | bitnami1 |
DOKUWIKI_WIKI_NAME | Name for the wiki | Bitnami DokuWiki |
Read-only environment variables
Name | Description | Value |
---|---|---|
DOKUWIKI_BASE_DIR | DokuWiki installation directory. | ${BITNAMI_ROOT_DIR}/dokuwiki |
DOKUWIKI_VOLUME_DIR | DokuWiki directory for mounted configuration files. | ${BITNAMI_VOLUME_DIR}/dokuwiki |
PHP_DEFAULT_MEMORY_LIMIT | Default PHP memory limit. | 256M |
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:
docker-compose.yml
file present in this repository:dokuwiki:
...
environment:
- DOKUWIKI_PASSWORD=my_password
...
For manual execution add a --env
option with each variable and value:
docker run -d --name dokuwiki -p 80:8080 -p 443:8443 \
--env DOKUWIKI_PASSWORD=my_password \
--network dokuwiki-tier \
--volume /path/to/dokuwiki-persistence:/bitnami/dokuwiki \
bitnami/dokuwiki:latest
The Bitnami DokuWiki Docker image sends the container logs to stdout
. To view the logs:
docker logs dokuwiki
Or using Docker Compose:
docker-compose logs dokuwiki
You can configure the containers logging driver using the --log-driver
option if you wish to consume the container logs differently. In the default configuration docker uses the json-file
driver.
To backup your data, configuration and logs, follow these simple steps:
Step 1: Stop the currently running container
docker stop dokuwiki
Or using Docker Compose:
docker-compose stop dokuwiki
Step 2: Run the backup command
We need to mount two volumes in a container we will use to create the backup: a directory on your host to store the backup in, and the volumes from the container we just stopped so we can access the data.
docker run --rm -v /path/to/dokuwiki-backups:/backups --volumes-from dokuwiki busybox \
cp -a /bitnami/dokuwiki /backups/latest
Restoring a backup is as simple as mounting the backup as volumes in the containers.
For the DokuWiki container:
$ docker run -d --name \
...
- --volume /path/to/-persistence:/bitnami/dokuwiki \
+ --volume /path/to/-backups/latest:/bitnami/dokuwiki \
bitnami/:latest
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.
Step 1: Get the updated image
docker pull bitnami/dokuwiki:latest
Step 2: Stop the running container
Stop the currently running container using the command
docker-compose stop dokuwiki
Step 3: Take a snapshot of the application state
Follow the steps in Backing up your container to take a snapshot of the current application state.
Step 4: Remove the currently running container
Remove the currently running container by executing the following command:
docker-compose rm -v dokuwiki
Step 5: Run the new image
Update the image tag in docker-compose.yml
and re-create your container with the new image:
docker-compose up -d
The Bitnami DokuWiki Docker image is designed to be extended so it can be used as the base image for your custom web applications.
Before extending this image, please note there are certain configuration settings you can modify using the original image:
APACHE_HTTP_PORT_NUMBER
and APACHE_HTTPS_PORT_NUMBER
respectively.If your desired customizations cannot be covered using the methods mentioned above, extend the image. To do so, create your own image using a Dockerfile with the format below:
FROM bitnami/dokuwiki
## Put your customizations below
...
Here is an example of extending the image with the following modifications:
vim
editorFROM bitnami/dokuwiki
## Change user to perform privileged actions
USER 0
## Install 'vim'
RUN install_packages vim
## Revert to the original non-root user
USER 1001
## Enable mod_ratelimit module
RUN sed -i -r 's/#LoadModule ratelimit_module/LoadModule ratelimit_module/' /opt/bitnami/apache/conf/httpd.conf
## Modify the ports used by Apache by default
# It is also possible to change these environment variables at runtime
ENV APACHE_HTTP_PORT_NUMBER=8181
ENV APACHE_HTTPS_PORT_NUMBER=8143
EXPOSE 8181 8143
Based on the extended image, you can update the docker-compose.yml
file present in this repository to add other features:
dokuwiki:
- image: bitnami/dokuwiki:latest
+ build: .
ports:
- - '80:8080'
- - '443:8443'
+ - '80:8181'
+ - '443:8143'
environment:
+ - PHP_MEMORY_LIMIT=512m
...
root
user and the Apache daemon was started as the daemon
user. From now on, both the container and the Apache daemon run as user 1001
. You can revert this behavior by changing USER 1001
to USER root
in the Dockerfile, or user: root
in docker-compose.yml
. Consequences:
8080/8443
instead of 80/443
./bitnami/apache
) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the Apache configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom Apache configuration files are advised to mount a volume for the configuration at /opt/bitnami/apache/conf
, or mount specific configuration files individually./bitnami/php
) has been deprecated, and support for this feature will be dropped in the near future. Until then, the container will enable the PHP configuration from that volume if it exists. By default, and if the configuration volume does not exist, the configuration files will be regenerated each time the container is created. Users wanting to apply custom PHP configuration files are advised to mount a volume for the configuration at /opt/bitnami/php/conf
, or mount specific configuration files individually./opt/bitnami/apache/certs
has been deprecated, and support for this functionality will be dropped in the near future. Users wanting to enable custom certificates are advised to mount their certificate files on top of the preconfigured ones at /certs
.lib/images/smileys/local
, are now persisted.lib/images/interwiki/
, are now persisted.docker-compose.yaml
Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart.
If you detect any issue in the docker-compose.yaml
file, feel free to report it or contribute with a fix by following our Contributing Guidelines.
We'd love for you to contribute to this container. You can request new features by creating an issue or submitting a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to fill the issue template.
Copyright © 2024 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
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.