kopia lustrzana https://github.com/linuxserver/docker-documentation
307 wiersze
13 KiB
Markdown
307 wiersze
13 KiB
Markdown
---
|
|
title: dokuwiki
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read https://github.com/linuxserver/docker-dokuwiki/blob/master/.github/CONTRIBUTING.md -->
|
|
# [linuxserver/dokuwiki](https://github.com/linuxserver/docker-dokuwiki)
|
|
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fdokuwiki)
|
|
[](https://github.com/linuxserver/docker-dokuwiki)
|
|
[](https://github.com/linuxserver/docker-dokuwiki/releases)
|
|
[](https://github.com/linuxserver/docker-dokuwiki/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-dokuwiki/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/dokuwiki)
|
|
[](https://hub.docker.com/r/linuxserver/dokuwiki)
|
|
[](https://hub.docker.com/r/linuxserver/dokuwiki)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-dokuwiki/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/dokuwiki/latest/index.html)
|
|
|
|
[Dokuwiki](https://www.dokuwiki.org/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. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.
|
|
|
|
[](https://www.dokuwiki.org/dokuwiki/)
|
|
|
|
## Supported Architectures
|
|
|
|
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
|
|
|
Simply pulling `lscr.io/linuxserver/dokuwiki:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
|
|
|
The architectures supported by this image are:
|
|
|
|
| Architecture | Available | Tag |
|
|
| :----: | :----: | ---- |
|
|
| x86-64 | ✅ | amd64-\<version tag\> |
|
|
| arm64 | ✅ | arm64v8-\<version tag\> |
|
|
| armhf | ❌ | |
|
|
|
|
## Application Setup
|
|
|
|
Upon first install go to `http://$IP:$PORT/install.php` once you have completed the setup, restart the container, login as admin and set "Use nice URLs" in the `admin/Configuration Settings` panel to `.htaccess` and tick `Use slash as namespace separator in URLs` to enable [nice URLs](https://www.dokuwiki.org/rewrite) you will find the webui at `http://$IP:$PORT/`, for more info see [Dokuwiki](https://www.dokuwiki.org/dokuwiki/)
|
|
|
|
## Usage
|
|
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
|
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
dokuwiki:
|
|
image: lscr.io/linuxserver/dokuwiki:latest
|
|
container_name: dokuwiki
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Etc/UTC
|
|
volumes:
|
|
- /path/to/appdata/config:/config
|
|
ports:
|
|
- 80:80
|
|
- 443:443 #optional
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=dokuwiki \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Etc/UTC \
|
|
-p 80:80 \
|
|
-p 443:443 `#optional` \
|
|
-v /path/to/appdata/config:/config \
|
|
--restart unless-stopped \
|
|
lscr.io/linuxserver/dokuwiki:latest
|
|
```
|
|
|
|
## Parameters
|
|
|
|
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
|
|
|
### Ports (`-p`)
|
|
|
|
| Parameter | Function |
|
|
| :----: | --- |
|
|
| `80` | Application HTTP Port |
|
|
| `443` | #optional Application HTTPS Port |
|
|
|
|
### Environment Variables (`-e`)
|
|
|
|
| Env | Function |
|
|
| :----: | --- |
|
|
| `PUID=1000` | for UserID - see below for explanation |
|
|
| `PGID=1000` | for GroupID - see below for explanation |
|
|
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
|
|
|
### Volume Mappings (`-v`)
|
|
|
|
| Volume | Function |
|
|
| :----: | --- |
|
|
| `/config` | Configuration files. |
|
|
|
|
#### Miscellaneous Options
|
|
|
|
| Parameter | Function |
|
|
| :-----: | --- |
|
|
|
|
## Environment variables from files (Docker secrets)
|
|
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
|
|
|
As an example:
|
|
|
|
```bash
|
|
-e FILE__MYVAR=/run/secrets/mysecretvariable
|
|
```
|
|
|
|
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
|
|
|
|
## Umask for running applications
|
|
|
|
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
|
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
|
|
|
## User / Group Identifiers
|
|
|
|
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
|
|
|
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
|
|
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
|
|
|
|
```bash
|
|
id your_user
|
|
```
|
|
|
|
Example output:
|
|
|
|
```text
|
|
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=dokuwiki "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
|
|
|
|
## Support Info
|
|
|
|
* Shell access whilst the container is running:
|
|
|
|
```bash
|
|
docker exec -it dokuwiki /bin/bash
|
|
```
|
|
|
|
* To monitor the logs of the container in realtime:
|
|
|
|
```bash
|
|
docker logs -f dokuwiki
|
|
```
|
|
|
|
* Container version number:
|
|
|
|
```bash
|
|
docker inspect -f '{{ index .Config.Labels "build_version" }}' dokuwiki
|
|
```
|
|
|
|
* Image version number:
|
|
|
|
```bash
|
|
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/dokuwiki:latest
|
|
```
|
|
|
|
## Updating Info
|
|
|
|
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
|
|
|
Below are the instructions for updating containers:
|
|
|
|
### Via Docker Compose
|
|
|
|
* Update images:
|
|
* All images:
|
|
|
|
```bash
|
|
docker-compose pull
|
|
```
|
|
|
|
* Single image:
|
|
|
|
```bash
|
|
docker-compose pull dokuwiki
|
|
```
|
|
|
|
* Update containers:
|
|
* All containers:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
* Single container:
|
|
|
|
```bash
|
|
docker-compose up -d dokuwiki
|
|
```
|
|
|
|
* You can also remove the old dangling images:
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
### Via Docker Run
|
|
|
|
* Update the image:
|
|
|
|
```bash
|
|
docker pull lscr.io/linuxserver/dokuwiki:latest
|
|
```
|
|
|
|
* Stop the running container:
|
|
|
|
```bash
|
|
docker stop dokuwiki
|
|
```
|
|
|
|
* Delete the container:
|
|
|
|
```bash
|
|
docker rm dokuwiki
|
|
```
|
|
|
|
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
|
* You can also remove the old dangling images:
|
|
|
|
```bash
|
|
docker image prune
|
|
```
|
|
|
|
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
|
|
|
|
* Pull the latest image at its tag and replace it with the same env variables in one run:
|
|
|
|
```bash
|
|
docker run --rm \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
containrrr/watchtower \
|
|
--run-once dokuwiki
|
|
```
|
|
|
|
* You can also remove the old dangling images: `docker image prune`
|
|
|
|
!!! warning
|
|
|
|
We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
|
|
|
|
### Image Update Notifications - Diun (Docker Image Update Notifier)
|
|
|
|
!!! tip
|
|
|
|
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
|
|
|
|
## Building locally
|
|
|
|
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
|
|
|
```bash
|
|
git clone https://github.com/linuxserver/docker-dokuwiki.git
|
|
cd docker-dokuwiki
|
|
docker build \
|
|
--no-cache \
|
|
--pull \
|
|
-t lscr.io/linuxserver/dokuwiki:latest .
|
|
```
|
|
|
|
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
|
|
|
```bash
|
|
docker run --rm --privileged multiarch/qemu-user-static:register --reset
|
|
```
|
|
|
|
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
|
|
|
## Versions
|
|
|
|
* **21.07.23:** - Update built-in plugins on container update.
|
|
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
|
|
* **13.04.23:** - Move ssl.conf include to default.conf.
|
|
* **28.12.22:** - Rebase to Alpine 3.17, migrate to s6v3.
|
|
* **11.13.22:** - Move lib/images/smileys/local and lib/images/interwiki outside of the container for user defined smiley and interwiki icon support.
|
|
* **20.08.22:** - Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base)).
|
|
* **20.07.21:** - Add php7-dom, fixes minor issues in sprintdoc template.
|
|
* **15.04.21:** - Add `vendor` folder to deny list.
|
|
* **21.02.21:** - Store search index outside of container, set absolute (default) path for `savedir`.
|
|
* **23.01.21:** - Rebasing to alpine 3.13.
|
|
* **28.09.20:** - Add php7-pdo_sqlite and php7-sqlite3.
|
|
* **23.09.20:** - Fix php-local.ini bug introduced in the prior PR.
|
|
* **14.09.20:** - Rebase to alpine 3.12. Add php7-ctype, php7-curl, php7-pdo_mysql, php7-pdo_pgsql, php7-pecl-imagick and php7-iconv. Bump upload max filesize and post max size to 100MB. Remove deprecated APP_URL env var. Fix breaking addons.
|
|
* **19.12.19:** - Rebasing to alpine 3.11.
|
|
* **01.12.19:** - Add php7-ldap package to support LDAP authentication.
|
|
* **28.05.19:** - Initial Release.
|