Skip to content
This repository was archived by the owner on Jan 7, 2024. It is now read-only.

Commit 6a3e351

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent dfbbd0a commit 6a3e351

File tree

5 files changed

+92
-56
lines changed

5 files changed

+92
-56
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
[linuxserverurl]: https://linuxserver.io
22
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
33

4-
If you are new to Docker or this application our issue tracker is **ONLY** used for reporting bugs or requesting features. Please use [our discord server](https://discord.gg/YWrKVTn) for general support.
4+
<!--- If you are new to Docker or this application our issue tracker is **ONLY** used for reporting bugs or requesting features. Please use [our discord server](https://discord.gg/YWrKVTn) for general support. --->
5+
6+
<!--- If this acts as a feature request please ask yourself if this modification is something the whole userbase will benefit from --->
7+
<!--- If this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ -->
58

69
<!--- Provide a general summary of the issue in the Title above -->
710

@@ -22,9 +25,10 @@ If you are new to Docker or this application our issue tracker is **ONLY** used
2225
4.
2326

2427
## Environment
25-
**OS:**
26-
**CPU architecture:** x86_64/arm32/arm64
27-
**How docker service was installed:**
28+
**OS:**
29+
**CPU architecture:** x86_64/arm32/arm64
30+
**How docker service was installed:**
31+
<!--- ie. from the official docker repo, from the distro repo, nas OS provided, etc. -->
2832
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
2933

3034
## Command used to create docker container (run/create/compose/screenshot)

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
[linuxserverurl]: https://linuxserver.io
44
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
5-
5+
66

77
<!--- Before submitting a pull request please check the following -->
88

9-
<!--- If this is a fix for a typo in code or documentation in the README please file an issue and let us sort it out we do not need a PR -->
9+
<!--- If this is a fix for a typo in code or documentation in the README please file an issue and let us sort it out we do not need a PR -->
1010
<!--- Ask yourself if this modification is something the whole userbase will benefit from, if this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ -->
1111
<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message -->
1212
<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message -->
@@ -21,7 +21,11 @@
2121

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

24-
We welcome all PR’s though this doesn’t guarantee it will be accepted.
24+
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-unifi-controller/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
25+
26+
------------------------------
27+
28+
<!--- We welcome all PR’s though this doesn’t guarantee it will be accepted. -->
2529

2630
## Description:
2731
<!--- Describe your changes in detail -->

‎.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 [issue template](https://github.com/linuxserver/docker-unifi-controller/.github/ISSUE_TEMPLATE.md)!'
12-
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-unifi-controller/.github/PULL_REQUEST_TEMPLATE.md)!'
11+
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [issue template](https://github.com/linuxserver/docker-unifi-controller/blob/master/.github/ISSUE_TEMPLATE.md)!'
12+
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-unifi-controller/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
1313
repo-token: ${{ secrets.GITHUB_TOKEN }}

‎Jenkinsfile

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ pipeline {
5555
env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT
5656
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/'
5757
env.PULL_REQUEST = env.CHANGE_ID
58-
env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE.md ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/greetings.yml ./.github/workflows/stale.yml'
58+
env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE ./.github/CONTRIBUTING.md ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE.md ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/greetings.yml ./.github/workflows/stale.yml'
5959
}
6060
script{
6161
env.LS_RELEASE_NUMBER = sh(
@@ -136,6 +136,7 @@ pipeline {
136136
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
137137
}
138138
env.META_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
139+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
139140
}
140141
}
141142
}
@@ -156,6 +157,7 @@ pipeline {
156157
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
157158
}
158159
env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
160+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
159161
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DEV_DOCKERHUB_IMAGE + '/tags/'
160162
}
161163
}
@@ -176,6 +178,7 @@ pipeline {
176178
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
177179
}
178180
env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
181+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
179182
env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/pull/' + env.PULL_REQUEST
180183
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.PR_DOCKERHUB_IMAGE + '/tags/'
181184
}
@@ -543,15 +546,18 @@ pipeline {
543546
for PUSHIMAGE in "${GITHUBIMAGE}" "${GITLABIMAGE}" "${IMAGE}"; do
544547
docker tag ${IMAGE}:${META_TAG} ${PUSHIMAGE}:${META_TAG}
545548
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:latest
549+
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:${EXT_RELEASE_TAG}
546550
docker push ${PUSHIMAGE}:latest
547551
docker push ${PUSHIMAGE}:${META_TAG}
552+
docker push ${PUSHIMAGE}:${EXT_RELEASE_TAG}
548553
done
549554
'''
550555
}
551556
sh '''#! /bin/bash
552557
for DELETEIMAGE in "${GITHUBIMAGE}" "{GITLABIMAGE}" "${IMAGE}"; do
553558
docker rmi \
554559
${DELETEIMAGE}:${META_TAG} \
560+
${DELETEIMAGE}:${EXT_RELEASE_TAG} \
555561
${DELETEIMAGE}:latest || :
556562
done
557563
'''
@@ -592,12 +598,18 @@ pipeline {
592598
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-latest
593599
docker tag ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm32v7-latest
594600
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-latest
601+
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG}
602+
docker tag ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG}
603+
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
595604
docker push ${MANIFESTIMAGE}:amd64-${META_TAG}
596605
docker push ${MANIFESTIMAGE}:arm32v7-${META_TAG}
597606
docker push ${MANIFESTIMAGE}:arm64v8-${META_TAG}
598607
docker push ${MANIFESTIMAGE}:amd64-latest
599608
docker push ${MANIFESTIMAGE}:arm32v7-latest
600609
docker push ${MANIFESTIMAGE}:arm64v8-latest
610+
docker push ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG}
611+
docker push ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG}
612+
docker push ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
601613
docker manifest push --purge ${MANIFESTIMAGE}:latest || :
602614
docker manifest create ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:arm32v7-latest ${MANIFESTIMAGE}:arm64v8-latest
603615
docker manifest annotate ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:arm32v7-latest --os linux --arch arm
@@ -606,8 +618,12 @@ pipeline {
606618
docker manifest create ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG}
607619
docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG} --os linux --arch arm
608620
docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} --os linux --arch arm64 --variant v8
621+
docker manifest create ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
622+
docker manifest annotate ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG} --os linux --arch arm
623+
docker manifest annotate ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} --os linux --arch arm64 --variant v8
609624
docker manifest push --purge ${MANIFESTIMAGE}:latest
610625
docker manifest push --purge ${MANIFESTIMAGE}:${META_TAG}
626+
docker manifest push --purge ${MANIFESTIMAGE}:${EXT_RELEASE_TAG}
611627
done
612628
docker tag ${IMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:amd64-${META_TAG}
613629
docker tag ${IMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-${META_TAG}
@@ -616,13 +632,21 @@ pipeline {
616632
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:${META_TAG}
617633
docker tag ${GITHUBIMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-latest
618634
docker tag ${GITHUBIMAGE}:arm64v8-${META_TAG} ${GITHUBIMAGE}:arm64v8-latest
635+
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:amd64-${EXT_RELEASE_TAG}
636+
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:${EXT_RELEASE_TAG}
637+
docker tag ${GITHUBIMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-${EXT_RELEASE_TAG}
638+
docker tag ${GITHUBIMAGE}:arm64v8-${META_TAG} ${GITHUBIMAGE}:arm64v8-${EXT_RELEASE_TAG}
619639
docker push ${GITHUBIMAGE}:amd64-${META_TAG}
620640
docker push ${GITHUBIMAGE}:arm32v7-${META_TAG}
621641
docker push ${GITHUBIMAGE}:arm64v8-${META_TAG}
622642
docker push ${GITHUBIMAGE}:latest
623643
docker push ${GITHUBIMAGE}:${META_TAG}
624644
docker push ${GITHUBIMAGE}:arm32v7-latest
625645
docker push ${GITHUBIMAGE}:arm64v8-latest
646+
docker push ${GITHUBIMAGE}:${EXT_RELEASE_TAG}
647+
docker push ${GITHUBIMAGE}:amd64-${EXT_RELEASE_TAG}
648+
docker push ${GITHUBIMAGE}:arm32v7-${EXT_RELEASE_TAG}
649+
docker push ${GITHUBIMAGE}:arm64v8-${EXT_RELEASE_TAG}
626650
'''
627651
}
628652
sh '''#! /bin/bash
@@ -691,7 +715,7 @@ pipeline {
691715
set -e
692716
TEMPDIR=$(mktemp -d)
693717
docker pull linuxserver/jenkins-builder:latest
694-
docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH=master -v ${TEMPDIR}:/ansible/jenkins linuxserver/jenkins-builder:latest
718+
docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH="${BRANCH_NAME}" -v ${TEMPDIR}:/ansible/jenkins linuxserver/jenkins-builder:latest
695719
docker pull lsiodev/readme-sync
696720
docker run --rm=true \
697721
-e DOCKERHUB_USERNAME=$DOCKERUSER \

‎README.md

Lines changed: 49 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read the CONTRIBUTING.md -->
3+
14
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
25

36
[![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!")
@@ -59,10 +62,40 @@ The architectures supported by this image are:
5962

6063
Here are some example snippets to help you get started creating a container.
6164

62-
### docker
65+
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
66+
67+
Compatible with docker-compose v2 schemas.
6368

69+
```yaml
70+
---
71+
version: "2.1"
72+
services:
73+
unifi-controller:
74+
image: linuxserver/unifi-controller
75+
container_name: unifi-controller
76+
environment:
77+
- PUID=1000
78+
- PGID=1000
79+
- MEM_LIMIT=1024M #optional
80+
volumes:
81+
- <path to data>:/config
82+
ports:
83+
- 3478:3478/udp
84+
- 10001:10001/udp
85+
- 8080:8080
86+
- 8443:8443
87+
- 1900:1900/udp #optional
88+
- 8843:8843 #optional
89+
- 8880:8880 #optional
90+
- 6789:6789 #optional
91+
- 5514:5514 #optional
92+
restart: unless-stopped
6493
```
65-
docker create \
94+
95+
### docker cli
96+
97+
```
98+
docker run -d \
6699
--name=unifi-controller \
67100
-e PUID=1000 \
68101
-e PGID=1000 \
@@ -97,36 +130,6 @@ This image provides various versions that are available via tags. `latest` tag p
97130
When using a Security Gateway (router) it could be that network connected devices are unable to obtain an ip address. This can be fixed by setting "DHCP Gateway IP", under Settings > Networks > network_name, to a correct (and accessable) ip address.
98131

99132

100-
### docker-compose
101-
102-
Compatible with docker-compose v2 schemas.
103-
104-
```
105-
---
106-
version: "2.1"
107-
services:
108-
unifi-controller:
109-
image: linuxserver/unifi-controller
110-
container_name: unifi-controller
111-
environment:
112-
- PUID=1000
113-
- PGID=1000
114-
- MEM_LIMIT=1024M #optional
115-
volumes:
116-
- <path to data>:/config
117-
ports:
118-
- 3478:3478/udp
119-
- 10001:10001/udp
120-
- 8080:8080
121-
- 8443:8443
122-
- 1900:1900/udp #optional
123-
- 8843:8843 #optional
124-
- 8880:8880 #optional
125-
- 6789:6789 #optional
126-
- 5514:5514 #optional
127-
restart: unless-stopped
128-
```
129-
130133
## Parameters
131134

132135
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.
@@ -196,9 +199,9 @@ Use `ubnt` as the password to login and `$address` is the IP address of the host
196199

197200

198201
## Docker Mods
199-
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mods&query=%24.mods%5B%27unifi-controller%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=unifi-controller "view available mods for this container.")
202+
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=unifi-controller&query=%24.mods%5B%27unifi-controller%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=unifi-controller "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.")
200203

201-
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) can be accessed via the dynamic badge above.
204+
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.
202205

203206

204207
## Support Info
@@ -216,33 +219,34 @@ Most of our images are static, versioned, and require an image update and contai
216219

217220
Below are the instructions for updating containers:
218221

219-
### Via Docker Run/Create
220-
* Update the image: `docker pull linuxserver/unifi-controller`
221-
* Stop the running container: `docker stop unifi-controller`
222-
* Delete the container: `docker rm unifi-controller`
223-
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
224-
* Start the new container: `docker start unifi-controller`
225-
* You can also remove the old dangling images: `docker image prune`
226-
227222
### Via Docker Compose
228223
* Update all images: `docker-compose pull`
229224
* or update a single image: `docker-compose pull unifi-controller`
230225
* Let compose update all containers as necessary: `docker-compose up -d`
231226
* or update a single container: `docker-compose up -d unifi-controller`
232227
* You can also remove the old dangling images: `docker image prune`
233228

234-
### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
229+
### Via Docker Run
230+
* Update the image: `docker pull linuxserver/unifi-controller`
231+
* Stop the running container: `docker stop unifi-controller`
232+
* Delete the container: `docker rm unifi-controller`
233+
* 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)
234+
* You can also remove the old dangling images: `docker image prune`
235+
236+
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
235237
* Pull the latest image at its tag and replace it with the same env variables in one run:
236238
```
237239
docker run --rm \
238240
-v /var/run/docker.sock:/var/run/docker.sock \
239241
containrrr/watchtower \
240242
--run-once unifi-controller
241243
```
244+
* You can also remove the old dangling images: `docker image prune`
242245

243-
**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.
246+
**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).
244247

245-
* You can also remove the old dangling images: `docker image prune`
248+
### Image Update Notifications - Diun (Docker Image Update Notifier)
249+
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
246250

247251
## Building locally
248252

0 commit comments

Comments
 (0)