Skip to content

Commit 5009317

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 5a1bddb commit 5009317

File tree

1 file changed

+100
-35
lines changed

1 file changed

+100
-35
lines changed

‎README.md‎

Lines changed: 100 additions & 35 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-wps-office/blob/master/.github/CONTRIBUTING.md -->
3-
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read https://github.com/linuxserver/docker-wps-office/blob/master/.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!")
@@ -97,7 +96,7 @@ This container is capable of delivering a true lossless image at a high framerat
9796

9897
## Usage
9998

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

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

@@ -138,12 +137,11 @@ docker run -d \
138137
--shm-size="1gb" \
139138
--restart unless-stopped \
140139
lscr.io/linuxserver/wps-office:latest
141-
142140
```
143141

144142
## Parameters
145143

146-
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.
144+
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.
147145

148146
| Parameter | Function |
149147
| :----: | --- |
@@ -163,10 +161,10 @@ You can set any environment variable from a file by using a special prepend `FIL
163161
As an example:
164162

165163
```bash
166-
-e FILE__PASSWORD=/run/secrets/mysecretpassword
164+
-e FILE__MYVAR=/run/secrets/mysecretvariable
167165
```
168166

169-
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
167+
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
170168

171169
## Umask for running applications
172170

@@ -175,15 +173,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
175173

176174
## User / Group Identifiers
177175

178-
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`.
176+
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`.
179177

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

182-
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
180+
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
183181

184182
```bash
185-
$ id username
186-
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
183+
id your_user
184+
```
185+
186+
Example output:
187+
188+
```text
189+
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
187190
```
188191

189192
## Docker Mods
@@ -194,12 +197,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
194197

195198
## Support Info
196199

197-
* Shell access whilst the container is running: `docker exec -it wps-office /bin/bash`
198-
* To monitor the logs of the container in realtime: `docker logs -f wps-office`
199-
* container version number
200-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' wps-office`
201-
* image version number
202-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wps-office:latest`
200+
* Shell access whilst the container is running:
201+
202+
```bash
203+
docker exec -it wps-office /bin/bash
204+
```
205+
206+
* To monitor the logs of the container in realtime:
207+
208+
```bash
209+
docker logs -f wps-office
210+
```
211+
212+
* Container version number:
213+
214+
```bash
215+
docker inspect -f '{{ index .Config.Labels "build_version" }}' wps-office
216+
```
217+
218+
* Image version number:
219+
220+
```bash
221+
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wps-office:latest
222+
```
203223

204224
## Updating Info
205225

@@ -209,38 +229,83 @@ Below are the instructions for updating containers:
209229

210230
### Via Docker Compose
211231

212-
* Update all images: `docker-compose pull`
213-
* or update a single image: `docker-compose pull wps-office`
214-
* Let compose update all containers as necessary: `docker-compose up -d`
215-
* or update a single container: `docker-compose up -d wps-office`
216-
* You can also remove the old dangling images: `docker image prune`
232+
* Update images:
233+
* All images:
234+
235+
```bash
236+
docker-compose pull
237+
```
238+
239+
* Single image:
240+
241+
```bash
242+
docker-compose pull wps-office
243+
```
244+
245+
* Update containers:
246+
* All containers:
247+
248+
```bash
249+
docker-compose up -d
250+
```
251+
252+
* Single container:
253+
254+
```bash
255+
docker-compose up -d wps-office
256+
```
257+
258+
* You can also remove the old dangling images:
259+
260+
```bash
261+
docker image prune
262+
```
217263

218264
### Via Docker Run
219265

220-
* Update the image: `docker pull lscr.io/linuxserver/wps-office:latest`
221-
* Stop the running container: `docker stop wps-office`
222-
* Delete the container: `docker rm wps-office`
266+
* Update the image:
267+
268+
```bash
269+
docker pull lscr.io/linuxserver/wps-office:latest
270+
```
271+
272+
* Stop the running container:
273+
274+
```bash
275+
docker stop wps-office
276+
```
277+
278+
* Delete the container:
279+
280+
```bash
281+
docker rm wps-office
282+
```
283+
223284
* 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)
224-
* You can also remove the old dangling images: `docker image prune`
285+
* You can also remove the old dangling images:
286+
287+
```bash
288+
docker image prune
289+
```
225290

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

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

230-
```bash
231-
docker run --rm \
232-
-v /var/run/docker.sock:/var/run/docker.sock \
233-
containrrr/watchtower \
234-
--run-once wps-office
235-
```
295+
```bash
296+
docker run --rm \
297+
-v /var/run/docker.sock:/var/run/docker.sock \
298+
containrrr/watchtower \
299+
--run-once wps-office
300+
```
236301

237302
* You can also remove the old dangling images: `docker image prune`
238303

239-
**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).
304+
**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).
240305

241306
### Image Update Notifications - Diun (Docker Image Update Notifier)
242307

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

245310
## Building locally
246311

0 commit comments

Comments
 (0)