Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crazy-max/docker-dokuwiki
DokuWiki Docker image
https://github.com/crazy-max/docker-dokuwiki
alpine-linux docker docker-compose dokuwiki nginx
Last synced: 8 days ago
JSON representation
DokuWiki Docker image
- Host: GitHub
- URL: https://github.com/crazy-max/docker-dokuwiki
- Owner: crazy-max
- License: mit
- Created: 2017-09-23T12:55:07.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T00:17:55.000Z (3 months ago)
- Last Synced: 2024-10-18T07:32:47.053Z (22 days ago)
- Topics: alpine-linux, docker, docker-compose, dokuwiki, nginx
- Language: Dockerfile
- Homepage:
- Size: 560 KB
- Stars: 43
- Watchers: 3
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Support: .github/SUPPORT.md
Awesome Lists containing this project
- awesome-starred - crazy-max/docker-dokuwiki - DokuWiki Docker image (docker)
README
## About
Docker image for [DokuWiki](https://www.dokuwiki.org/dokuwiki), a simple to use
and highly versatile Open Source wiki software that doesn't require a database.
> [!TIP]
> Want to be notified of new releases? Check out 🔔 [Diun (Docker Image Update Notifier)](https://github.com/crazy-max/diun)
> project!
___
* [Features](#features)
* [Build locally](#build-locally)
* [Image](#image)
* [Environment variables](#environment-variables)
* [Volumes](#volumes)
* [Ports](#ports)
* [Usage](#usage)
* [Docker Compose](#docker-compose)
* [Command line](#command-line)
* [Upgrade](#upgrade)
* [Notes](#notes)
* [Sending mails with SMTP](#sending-mails-with-smtp)
* [Contributing](#contributing)
* [License](#license)
## Features
* Run as non-root user
* Multi-platform image
* [msmtpd SMTP relay](https://github.com/crazy-max/docker-msmtpd) image to send emails
* [Traefik](https://github.com/containous/traefik-library-image) as reverse proxy and creation/renewal of Let's Encrypt certificates (see [this template](examples/traefik))
## Build locally
```shell
git clone https://github.com/crazy-max/docker-dokuwiki.git
cd docker-dokuwiki
# Build image and output to docker (default)
docker buildx bake
# Build multi-platform image
docker buildx bake image-all
```
## Image
| Registry | Image |
|-----------------------------------------------------------------------------------------------------|------------------------------|
| [Docker Hub](https://hub.docker.com/r/crazymax/dokuwiki/) | `crazymax/dokuwiki` |
| [GitHub Container Registry](https://github.com/users/crazy-max/packages/container/package/dokuwiki) | `ghcr.io/crazy-max/dokuwiki` |
Following platforms for this image are available:
```
$ docker run --rm mplatform/mquery crazymax/dokuwiki:latest
Image: crazymax/dokuwiki:latest
* Manifest List: Yes
* Supported platforms:
- linux/amd64
- linux/arm/v6
- linux/arm/v7
- linux/arm64
- linux/ppc64le
- linux/s390x
```
## Environment variables
* `TZ`: The timezone assigned to the container (default `UTC`)
* `PUID`: Dokuwiki user id (default `1500`)
* `PGID`: Dokuwiki group id (default `1500`)
* `MEMORY_LIMIT`: PHP memory limit (default `256M`)
* `UPLOAD_MAX_SIZE`: Upload max size (default `16M`)
* `CLEAR_ENV`: Clear environment in FPM workers (default `yes`)
* `OPCACHE_MEM_SIZE`: PHP OpCache memory consumption (default `128`)
* `LISTEN_IPV6`: Enable IPv6 for Nginx (default `true`)
* `REAL_IP_FROM`: Trusted addresses that are known to send correct replacement addresses (default `0.0.0.0/32`)
* `REAL_IP_HEADER`: Request header field whose value will be used to replace the client address (default `X-Forwarded-For`)
* `LOG_IP_VAR`: Use another variable to retrieve the remote IP address for access [log_format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format) on Nginx. (default `remote_addr`)
* `DOKUWIKI_RUN_INDEXER`: Run DokuWiki indexer on startup (default `true`)
## Volumes
* `/data`: Contains configuration, plugins, templates and data
> :warning: Note that the volume should be owned by the user/group with the
> specified `PUID` and `PGID`. If you don't give the volume correct permissions,
> the container may not start.
## Ports
* `8000`: HTTP port
## Usage
### Docker Compose
Docker compose is the recommended way to run this image. Copy the content of
folder [examples/compose](examples/compose) in `/var/dokuwiki/` on your host
for example. Edit the compose and env files with your preferences and run the
following commands:
```bash
docker compose up -d
docker compose logs -f
```
### Command line
You can also use the following minimal command :
```bash
docker run -d -p 8000:8000 --name dokuwiki \
-v $(pwd)/data:/data \
crazymax/dokuwiki:latest
```
## Upgrade
Recreate the container whenever I push an update:
```bash
docker compose pull
docker compose up -d
```
## Notes
### Sending mails with SMTP
A Dokuwiki [SMTP Plugin](https://www.dokuwiki.org/plugin:smtp) is available to
send emails over external SMTP servers. When the plugin is installed you have
to configure it:
Here we use our `msmtpd` service published on port `2500` declared in our
[`compose.yml`](examples/compose/compose.yml).
## Contributing
Want to contribute? Awesome! The most basic way to show your support is to star
the project, or to raise issues. You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max)
or by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this
journey continues indefinitely!
Thanks again for your support, it is much appreciated! :pray:
## License
MIT. See `LICENSE` for more details.