Skip to content
This repository was archived by the owner on Oct 25, 2023. It is now read-only.

Commit 7812fed

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 499addf commit 7812fed

1 file changed

Lines changed: 100 additions & 35 deletions

File tree

‎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-embystat/blob/master/.github/CONTRIBUTING.md -->
3-
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read https://github.com/linuxserver/docker-embystat/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!")
@@ -64,7 +63,7 @@ Access the webui at `<your-ip>:6555`. Follow the setup wizard on initial install
6463

6564
## Usage
6665

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

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

@@ -98,12 +97,11 @@ docker run -d \
9897
-v /path/to/appdata/config:/config \
9998
--restart unless-stopped \
10099
lscr.io/linuxserver/embystat:latest
101-
102100
```
103101

104102
## Parameters
105103

106-
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.
104+
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.
107105

108106
| Parameter | Function |
109107
| :----: | --- |
@@ -120,10 +118,10 @@ You can set any environment variable from a file by using a special prepend `FIL
120118
As an example:
121119

122120
```bash
123-
-e FILE__PASSWORD=/run/secrets/mysecretpassword
121+
-e FILE__MYVAR=/run/secrets/mysecretvariable
124122
```
125123

126-
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
124+
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
127125

128126
## Umask for running applications
129127

@@ -132,15 +130,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
132130

133131
## User / Group Identifiers
134132

135-
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`.
133+
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`.
136134

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

139-
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
137+
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
140138

141139
```bash
142-
$ id username
143-
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
140+
id your_user
141+
```
142+
143+
Example output:
144+
145+
```text
146+
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
144147
```
145148

146149
## Docker Mods
@@ -151,12 +154,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
151154

152155
## Support Info
153156

154-
* Shell access whilst the container is running: `docker exec -it embystat /bin/bash`
155-
* To monitor the logs of the container in realtime: `docker logs -f embystat`
156-
* container version number
157-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' embystat`
158-
* image version number
159-
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/embystat:latest`
157+
* Shell access whilst the container is running:
158+
159+
```bash
160+
docker exec -it embystat /bin/bash
161+
```
162+
163+
* To monitor the logs of the container in realtime:
164+
165+
```bash
166+
docker logs -f embystat
167+
```
168+
169+
* Container version number:
170+
171+
```bash
172+
docker inspect -f '{{ index .Config.Labels "build_version" }}' embystat
173+
```
174+
175+
* Image version number:
176+
177+
```bash
178+
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/embystat:latest
179+
```
160180

161181
## Updating Info
162182

@@ -166,38 +186,83 @@ Below are the instructions for updating containers:
166186

167187
### Via Docker Compose
168188

169-
* Update all images: `docker-compose pull`
170-
* or update a single image: `docker-compose pull embystat`
171-
* Let compose update all containers as necessary: `docker-compose up -d`
172-
* or update a single container: `docker-compose up -d embystat`
173-
* You can also remove the old dangling images: `docker image prune`
189+
* Update images:
190+
* All images:
191+
192+
```bash
193+
docker-compose pull
194+
```
195+
196+
* Single image:
197+
198+
```bash
199+
docker-compose pull embystat
200+
```
201+
202+
* Update containers:
203+
* All containers:
204+
205+
```bash
206+
docker-compose up -d
207+
```
208+
209+
* Single container:
210+
211+
```bash
212+
docker-compose up -d embystat
213+
```
214+
215+
* You can also remove the old dangling images:
216+
217+
```bash
218+
docker image prune
219+
```
174220

175221
### Via Docker Run
176222

177-
* Update the image: `docker pull lscr.io/linuxserver/embystat:latest`
178-
* Stop the running container: `docker stop embystat`
179-
* Delete the container: `docker rm embystat`
223+
* Update the image:
224+
225+
```bash
226+
docker pull lscr.io/linuxserver/embystat:latest
227+
```
228+
229+
* Stop the running container:
230+
231+
```bash
232+
docker stop embystat
233+
```
234+
235+
* Delete the container:
236+
237+
```bash
238+
docker rm embystat
239+
```
240+
180241
* 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)
181-
* You can also remove the old dangling images: `docker image prune`
242+
* You can also remove the old dangling images:
243+
244+
```bash
245+
docker image prune
246+
```
182247

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

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

187-
```bash
188-
docker run --rm \
189-
-v /var/run/docker.sock:/var/run/docker.sock \
190-
containrrr/watchtower \
191-
--run-once embystat
192-
```
252+
```bash
253+
docker run --rm \
254+
-v /var/run/docker.sock:/var/run/docker.sock \
255+
containrrr/watchtower \
256+
--run-once embystat
257+
```
193258

194259
* You can also remove the old dangling images: `docker image prune`
195260

196-
**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).
261+
**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).
197262

198263
### Image Update Notifications - Diun (Docker Image Update Notifier)
199264

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

202267
## Building locally
203268

0 commit comments

Comments
 (0)