Skip to content

Commit 7260d09

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 1bac4d1 commit 7260d09

File tree

1 file changed

+102
-37
lines changed

1 file changed

+102
-37
lines changed

‎README.md‎

Lines changed: 102 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the https://github.com/linuxserver/docker-kimai/blob/main/.github/CONTRIBUTING.md -->
3-
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read https://github.com/linuxserver/docker-kimai/blob/main/.github/CONTRIBUTING.md -->
43
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
54

65
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
@@ -94,7 +93,7 @@ Access the web gui at `https://<your-ip>:80`, for more information check out [Ki
9493

9594
## Usage
9695

97-
Here are some example snippets to help you get started creating a container.
96+
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
9897

9998
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
10099

@@ -116,7 +115,8 @@ services:
116115
- 80:80
117116
- 443:443
118117
restart: unless-stopped
119-
# This container requires an external application to be run separately to be run separately.
118+
119+
# This container requires an external application to be run separately.
120120
# MariaDB
121121
mariadb:
122122
image: lscr.io/linuxserver/mariadb:latest
@@ -135,7 +135,6 @@ services:
135135
- 3306:3306
136136
restart: unless-stopped
137137

138-
139138
```
140139

141140
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
@@ -168,12 +167,11 @@ docker run -d \
168167
--restart unless-stopped \
169168
lscr.io/linuxserver/mariadb:latest
170169

171-
172170
```
173171

174172
## Parameters
175173

176-
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.
174+
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.
177175

178176
| Parameter | Function |
179177
| :----: | --- |
@@ -192,10 +190,10 @@ You can set any environment variable from a file by using a special prepend `FIL
192190
As an example:
193191

194192
```bash
195-
-e FILE__PASSWORD=/run/secrets/mysecretpassword
193+
-e FILE__MYVAR=/run/secrets/mysecretvariable
196194
```
197195

198-
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
196+
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
199197

200198
## Umask for running applications
201199

@@ -204,15 +202,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
204202

205203
## User / Group Identifiers
206204

207-
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`.
205+
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`.
208206

209207
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
210208

211-
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
209+
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
212210

213211
```bash
214-
$ id username
215-
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
212+
id your_user
213+
```
214+
215+
Example output:
216+
217+
```text
218+
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
216219
```
217220

218221
## Docker Mods
@@ -223,12 +226,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
223226

224227
## Support Info
225228

226-
* Shell access whilst the container is running: `docker exec -it kimai /bin/bash`
227-
* To monitor the logs of the container in realtime: `docker logs -f kimai`
228-
* container version number
229-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' kimai`
230-
* image version number
231-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kimai:latest`
229+
* Shell access whilst the container is running:
230+
231+
```bash
232+
docker exec -it kimai /bin/bash
233+
```
234+
235+
* To monitor the logs of the container in realtime:
236+
237+
```bash
238+
docker logs -f kimai
239+
```
240+
241+
* Container version number:
242+
243+
```bash
244+
docker inspect -f '{{ index .Config.Labels "build_version" }}' kimai
245+
```
246+
247+
* Image version number:
248+
249+
```bash
250+
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kimai:latest
251+
```
232252

233253
## Updating Info
234254

@@ -238,38 +258,83 @@ Below are the instructions for updating containers:
238258

239259
### Via Docker Compose
240260

241-
* Update all images: `docker-compose pull`
242-
* or update a single image: `docker-compose pull kimai`
243-
* Let compose update all containers as necessary: `docker-compose up -d`
244-
* or update a single container: `docker-compose up -d kimai`
245-
* You can also remove the old dangling images: `docker image prune`
261+
* Update images:
262+
* All images:
263+
264+
```bash
265+
docker-compose pull
266+
```
267+
268+
* Single image:
269+
270+
```bash
271+
docker-compose pull kimai
272+
```
273+
274+
* Update containers:
275+
* All containers:
276+
277+
```bash
278+
docker-compose up -d
279+
```
280+
281+
* Single container:
282+
283+
```bash
284+
docker-compose up -d kimai
285+
```
286+
287+
* You can also remove the old dangling images:
288+
289+
```bash
290+
docker image prune
291+
```
246292

247293
### Via Docker Run
248294

249-
* Update the image: `docker pull lscr.io/linuxserver/kimai:latest`
250-
* Stop the running container: `docker stop kimai`
251-
* Delete the container: `docker rm kimai`
295+
* Update the image:
296+
297+
```bash
298+
docker pull lscr.io/linuxserver/kimai:latest
299+
```
300+
301+
* Stop the running container:
302+
303+
```bash
304+
docker stop kimai
305+
```
306+
307+
* Delete the container:
308+
309+
```bash
310+
docker rm kimai
311+
```
312+
252313
* 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)
253-
* You can also remove the old dangling images: `docker image prune`
314+
* You can also remove the old dangling images:
315+
316+
```bash
317+
docker image prune
318+
```
254319

255320
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
256321

257322
* Pull the latest image at its tag and replace it with the same env variables in one run:
258323

259-
```bash
260-
docker run --rm \
261-
-v /var/run/docker.sock:/var/run/docker.sock \
262-
containrrr/watchtower \
263-
--run-once kimai
264-
```
324+
```bash
325+
docker run --rm \
326+
-v /var/run/docker.sock:/var/run/docker.sock \
327+
containrrr/watchtower \
328+
--run-once kimai
329+
```
265330

266331
* You can also remove the old dangling images: `docker image prune`
267332

268-
**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).
333+
**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).
269334

270335
### Image Update Notifications - Diun (Docker Image Update Notifier)
271336

272-
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
337+
**tip**: We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
273338

274339
## Building locally
275340

0 commit comments

Comments
 (0)