Skip to content

Commit 34dad58

Browse files
committed
fix jenkinsfile
1 parent 68877c7 commit 34dad58

File tree

6 files changed

+40
-39
lines changed

6 files changed

+40
-39
lines changed

.github/CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
## Readme
2525

2626
If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit.
27-
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-overseerr/edit/master/readme-vars.yml).
27+
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-overseerr/edit/develop/readme-vars.yml).
2828

2929
These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play.
3030
Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-overseerr)
@@ -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-overseerr.git
101101
cd docker-overseerr
102102
docker build \
@@ -106,15 +106,16 @@ 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

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

119120
```yml
120121
changelogs:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
------------------------------
2323

24-
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-overseerr/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
24+
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-overseerr/blob/develop/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
2525

2626
------------------------------
2727

.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 develop branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_OVERSEERR_DEVELOP\". ****"
2020
echo "**** Retrieving external version ****"
21-
EXT_RELEASE=$(curl -sX GET https://api.github.com/repos/sct/overseerr/commits?sha=develop | jq -r 'first(.[] | select(.commit.message | contains("[skip ci]") | not)) | .sha')
21+
EXT_RELEASE=$(curl -u ${{ secrets.CR_USER }}:${{ secrets.CR_PAT }} -sX GET https://api.github.com/repos/sct/overseerr/commits?sha=develop | jq -r 'first(.[] | select(.commit.message | contains("[skip ci]") | not)) | .sha')
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 overseerr branch develop"

.github/workflows/greetings.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ jobs:
88
steps:
99
- uses: actions/first-interaction@v1
1010
with:
11-
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-overseerr/blob/master/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-overseerr/blob/master/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!'
12-
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-overseerr/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
11+
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-overseerr/blob/develop/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-overseerr/blob/develop/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!'
12+
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-overseerr/blob/develop/.github/PULL_REQUEST_TEMPLATE.md)!'
1313
repo-token: ${{ secrets.GITHUB_TOKEN }}

Jenkinsfile

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -393,8 +393,7 @@ pipeline {
393393
--label \"org.opencontainers.image.licenses=GPL-3.0-only\" \
394394
--label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \
395395
--label \"org.opencontainers.image.title=Overseerr\" \
396-
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
397-
\" \
396+
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library. \" \
398397
--no-cache --pull -t ${IMAGE}:${META_TAG} \
399398
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
400399
}
@@ -421,8 +420,7 @@ pipeline {
421420
--label \"org.opencontainers.image.licenses=GPL-3.0-only\" \
422421
--label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \
423422
--label \"org.opencontainers.image.title=Overseerr\" \
424-
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
425-
\" \
423+
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library. \" \
426424
--no-cache --pull -t ${IMAGE}:amd64-${META_TAG} \
427425
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
428426
}
@@ -449,8 +447,7 @@ pipeline {
449447
--label \"org.opencontainers.image.licenses=GPL-3.0-only\" \
450448
--label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \
451449
--label \"org.opencontainers.image.title=Overseerr\" \
452-
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
453-
\" \
450+
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library. \" \
454451
--no-cache --pull -f Dockerfile.armhf -t ${IMAGE}:arm32v7-${META_TAG} \
455452
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
456453
sh "docker tag ${IMAGE}:arm32v7-${META_TAG} ghcr.io/linuxserver/lsiodev-buildcache:arm32v7-${COMMIT_SHA}-${BUILD_NUMBER}"
@@ -484,8 +481,7 @@ pipeline {
484481
--label \"org.opencontainers.image.licenses=GPL-3.0-only\" \
485482
--label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \
486483
--label \"org.opencontainers.image.title=Overseerr\" \
487-
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
488-
\" \
484+
--label \"org.opencontainers.image.description=[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library. \" \
489485
--no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} \
490486
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
491487
sh "docker tag ${IMAGE}:arm64v8-${META_TAG} ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}"

README.md

Lines changed: 26 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-overseerr/blob/develop/.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
[Overseerr](https://overseerr.dev/) is a free and open source software application for managing requests for your media library.
4243

43-
4444
[![overseerr](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/overseerr.png)](https://overseerr.dev/)
4545

4646
## Supported Architectures
@@ -66,6 +66,10 @@ This image provides various versions that are available via tags. `latest` tag u
6666
| latest | Stable releases from GitHub |
6767
| develop | Development releases from commits in upstream develop branch |
6868

69+
## Application Setup
70+
71+
Access the webui at `<your-ip>:5055`, for more information check out [Overseerr](https://overseerr.dev/).
72+
6973
## Usage
7074

7175
Here are some example snippets to help you get started creating a container.
@@ -94,7 +98,7 @@ services:
9498
9599
### docker cli
96100
97-
```
101+
```bash
98102
docker run -d \
99103
--name=overseerr \
100104
-e PUID=1000 \
@@ -106,7 +110,6 @@ docker run -d \
106110
ghcr.io/linuxserver/overseerr
107111
```
108112

109-
110113
## Parameters
111114

112115
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.
@@ -125,7 +128,7 @@ You can set any environment variable from a file by using a special prepend `FIL
125128

126129
As an example:
127130

128-
```
131+
```bash
129132
-e FILE__PASSWORD=/run/secrets/mysecretpassword
130133
```
131134

@@ -144,24 +147,17 @@ Ensure any volume directories on the host are owned by the same user you specify
144147

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

147-
```
150+
```bash
148151
$ id username
149152
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
150153
```
151154

152-
153-
&nbsp;
154-
## Application Setup
155-
156-
Access the webui at `<your-ip>:5055`, for more information check out [Overseerr](https://overseerr.dev/).
157-
158-
159155
## Docker Mods
156+
160157
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=overseerr&query=%24.mods%5B%27overseerr%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=overseerr "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.")
161158

162159
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.
163160

164-
165161
## Support Info
166162

167163
* Shell access whilst the container is running: `docker exec -it overseerr /bin/bash`
@@ -178,38 +174,45 @@ Most of our images are static, versioned, and require an image update and contai
178174
Below are the instructions for updating containers:
179175

180176
### Via Docker Compose
177+
181178
* Update all images: `docker-compose pull`
182179
* or update a single image: `docker-compose pull overseerr`
183180
* Let compose update all containers as necessary: `docker-compose up -d`
184181
* or update a single container: `docker-compose up -d overseerr`
185182
* You can also remove the old dangling images: `docker image prune`
186183

187184
### Via Docker Run
185+
188186
* Update the image: `docker pull ghcr.io/linuxserver/overseerr`
189187
* Stop the running container: `docker stop overseerr`
190188
* Delete the container: `docker rm overseerr`
191189
* 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)
192190
* You can also remove the old dangling images: `docker image prune`
193191

194192
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
193+
195194
* Pull the latest image at its tag and replace it with the same env variables in one run:
196-
```
195+
196+
```bash
197197
docker run --rm \
198198
-v /var/run/docker.sock:/var/run/docker.sock \
199199
containrrr/watchtower \
200200
--run-once overseerr
201201
```
202+
202203
* You can also remove the old dangling images: `docker image prune`
203204

204205
**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).
205206

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

209211
## Building locally
210212

211213
If you want to make local modifications to these images for development purposes or just to customize the logic:
212-
```
214+
215+
```bash
213216
git clone https://github.com/linuxserver/docker-overseerr.git
214217
cd docker-overseerr
215218
docker build \
@@ -219,7 +222,8 @@ docker build \
219222
```
220223

221224
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
222-
```
225+
226+
```bash
223227
docker run --rm --privileged multiarch/qemu-user-static:register --reset
224228
```
225229

0 commit comments

Comments
 (0)