Skip to content

Commit 438120d

Browse files
Bot Updating Templated Files
1 parent 85602a4 commit 438120d

File tree

2 files changed

+29
-25
lines changed

2 files changed

+29
-25
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If you are proposing additional packages to be added, ensure that you added the
9696

9797
### Testing your changes
9898

99-
```
99+
```bash
100100
git clone https://github.com/linuxserver/docker-dokuwiki.git
101101
cd docker-dokuwiki
102102
docker build \
@@ -106,13 +106,14 @@ docker build \
106106
```
107107

108108
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109-
```
109+
110+
```bash
110111
docker run --rm --privileged multiarch/qemu-user-static:register --reset
111112
```
112113

113114
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
114115

115-
## Update the chagelog
116+
## Update the changelog
116117

117118
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-dokuwiki/tree/master/root), add an entry to the changelog
118119

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the CONTRIBUTING.md -->
2+
<!-- Please read the https://github.com/linuxserver/docker-dokuwiki/blob/master/.github/CONTRIBUTING.md -->
33

44
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
55

@@ -12,13 +12,14 @@
1212

1313
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
1414

15-
* regular and timely application updates
16-
* easy user mappings (PGID, PUID)
17-
* custom base image with s6 overlay
18-
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19-
* regular security updates
15+
* regular and timely application updates
16+
* easy user mappings (PGID, PUID)
17+
* custom base image with s6 overlay
18+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19+
* regular security updates
2020

2121
Find us at:
22+
2223
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2324
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
2425
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
@@ -40,7 +41,6 @@ Find us at:
4041

4142
[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.
4243

43-
4444
[![dokuwiki](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/dokuwiki-icon.png)](https://www.dokuwiki.org/dokuwiki/)
4545

4646
## Supported Architectures
@@ -57,6 +57,9 @@ The architectures supported by this image are:
5757
| arm64 | arm64v8-latest |
5858
| armhf | arm32v7-latest |
5959

60+
## Application Setup
61+
62+
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/)
6063

6164
## Usage
6265

@@ -87,7 +90,7 @@ services:
8790
8891
### docker cli
8992
90-
```
93+
```bash
9194
docker run -d \
9295
--name=dokuwiki \
9396
-e PUID=1000 \
@@ -100,7 +103,6 @@ docker run -d \
100103
ghcr.io/linuxserver/dokuwiki
101104
```
102105

103-
104106
## Parameters
105107

106108
Container images 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.
@@ -120,7 +122,7 @@ You can set any environment variable from a file by using a special prepend `FIL
120122

121123
As an example:
122124

123-
```
125+
```bash
124126
-e FILE__PASSWORD=/run/secrets/mysecretpassword
125127
```
126128

@@ -139,24 +141,17 @@ Ensure any volume directories on the host are owned by the same user you specify
139141

140142
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
141143

142-
```
144+
```bash
143145
$ id username
144146
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
145147
```
146148

147-
148-
&nbsp;
149-
## Application Setup
150-
151-
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/)
152-
153-
154149
## Docker Mods
150+
155151
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=dokuwiki&query=%24.mods%5B%27dokuwiki%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=dokuwiki "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
156152

157153
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.
158154

159-
160155
## Support Info
161156

162157
* Shell access whilst the container is running: `docker exec -it dokuwiki /bin/bash`
@@ -173,38 +168,45 @@ Most of our images are static, versioned, and require an image update and contai
173168
Below are the instructions for updating containers:
174169

175170
### Via Docker Compose
171+
176172
* Update all images: `docker-compose pull`
177173
* or update a single image: `docker-compose pull dokuwiki`
178174
* Let compose update all containers as necessary: `docker-compose up -d`
179175
* or update a single container: `docker-compose up -d dokuwiki`
180176
* You can also remove the old dangling images: `docker image prune`
181177

182178
### Via Docker Run
179+
183180
* Update the image: `docker pull ghcr.io/linuxserver/dokuwiki`
184181
* Stop the running container: `docker stop dokuwiki`
185182
* Delete the container: `docker rm dokuwiki`
186183
* 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)
187184
* You can also remove the old dangling images: `docker image prune`
188185

189186
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
187+
190188
* Pull the latest image at its tag and replace it with the same env variables in one run:
191-
```
189+
190+
```bash
192191
docker run --rm \
193192
-v /var/run/docker.sock:/var/run/docker.sock \
194193
containrrr/watchtower \
195194
--run-once dokuwiki
196195
```
196+
197197
* You can also remove the old dangling images: `docker image prune`
198198

199199
**Note:** 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).
200200

201201
### Image Update Notifications - Diun (Docker Image Update Notifier)
202+
202203
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
203204

204205
## Building locally
205206

206207
If you want to make local modifications to these images for development purposes or just to customize the logic:
207-
```
208+
209+
```bash
208210
git clone https://github.com/linuxserver/docker-dokuwiki.git
209211
cd docker-dokuwiki
210212
docker build \
@@ -214,7 +216,8 @@ docker build \
214216
```
215217

216218
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
217-
```
219+
220+
```bash
218221
docker run --rm --privileged multiarch/qemu-user-static:register --reset
219222
```
220223

0 commit comments

Comments
 (0)