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

Commit 711b773

Browse files
Bot Updating Templated Files
1 parent 3a36894 commit 711b773

File tree

3 files changed

+30
-25
lines changed

3 files changed

+30
-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-embystat.git
101101
cd docker-embystat
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-embystat/tree/master/root), add an entry to the changelog
118119

.github/workflows/external_trigger.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
fi
1919
echo "**** External trigger running off of master branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_EMBYSTAT_MASTER\". ****"
2020
echo "**** Retrieving external version ****"
21-
EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/mregni/EmbyStat/releases" | jq -r ". | first(.[] | .tag_name)")
21+
EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/mregni/EmbyStat/releases" | jq -r '. | first(.[] | .tag_name)')
2222
if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then
2323
echo "**** Can't retrieve external version, exiting ****"
2424
FAILURE_REASON="Can't retrieve external version for embystat branch master"

README.md

Lines changed: 25 additions & 21 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-embystat/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.
@@ -56,6 +57,9 @@ The architectures supported by this image are:
5657
| arm64 | arm64v8-latest |
5758
| armhf | arm32v7-latest |
5859

60+
## Application Setup
61+
62+
Access the webui at `<your-ip>:6555`. Follow the setup wizard on initial install. Then configure the required services.
5963

6064
## Usage
6165

@@ -85,7 +89,7 @@ services:
8589
8690
### docker cli
8791
88-
```
92+
```bash
8993
docker run -d \
9094
--name=embystat \
9195
-e PUID=1000 \
@@ -97,7 +101,6 @@ docker run -d \
97101
ghcr.io/linuxserver/embystat
98102
```
99103

100-
101104
## Parameters
102105

103106
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.
@@ -116,7 +119,7 @@ You can set any environment variable from a file by using a special prepend `FIL
116119

117120
As an example:
118121

119-
```
122+
```bash
120123
-e FILE__PASSWORD=/run/secrets/mysecretpassword
121124
```
122125

@@ -135,24 +138,17 @@ Ensure any volume directories on the host are owned by the same user you specify
135138

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

138-
```
141+
```bash
139142
$ id username
140143
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
141144
```
142145

143-
144-
&nbsp;
145-
## Application Setup
146-
147-
Access the webui at `<your-ip>:6555`. Follow the setup wizard on initial install. Then configure the required services.
148-
149-
150146
## Docker Mods
147+
151148
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=embystat&query=%24.mods%5B%27embystat%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=embystat "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.")
152149

153150
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.
154151

155-
156152
## Support Info
157153

158154
* Shell access whilst the container is running: `docker exec -it embystat /bin/bash`
@@ -169,38 +165,45 @@ Most of our images are static, versioned, and require an image update and contai
169165
Below are the instructions for updating containers:
170166

171167
### Via Docker Compose
168+
172169
* Update all images: `docker-compose pull`
173170
* or update a single image: `docker-compose pull embystat`
174171
* Let compose update all containers as necessary: `docker-compose up -d`
175172
* or update a single container: `docker-compose up -d embystat`
176173
* You can also remove the old dangling images: `docker image prune`
177174

178175
### Via Docker Run
176+
179177
* Update the image: `docker pull ghcr.io/linuxserver/embystat`
180178
* Stop the running container: `docker stop embystat`
181179
* Delete the container: `docker rm embystat`
182180
* 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)
183181
* You can also remove the old dangling images: `docker image prune`
184182

185183
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
184+
186185
* Pull the latest image at its tag and replace it with the same env variables in one run:
187-
```
186+
187+
```bash
188188
docker run --rm \
189189
-v /var/run/docker.sock:/var/run/docker.sock \
190190
containrrr/watchtower \
191191
--run-once embystat
192192
```
193+
193194
* You can also remove the old dangling images: `docker image prune`
194195

195196
**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).
196197

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

200202
## Building locally
201203

202204
If you want to make local modifications to these images for development purposes or just to customize the logic:
203-
```
205+
206+
```bash
204207
git clone https://github.com/linuxserver/docker-embystat.git
205208
cd docker-embystat
206209
docker build \
@@ -210,7 +213,8 @@ docker build \
210213
```
211214

212215
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
213-
```
216+
217+
```bash
214218
docker run --rm --privileged multiarch/qemu-user-static:register --reset
215219
```
216220

0 commit comments

Comments
 (0)