Skip to content

Commit 2d1e2e2

Browse files
Bot Updating Templated Files
1 parent e3db94f commit 2d1e2e2

File tree

6 files changed

+42
-36
lines changed

6 files changed

+42
-36
lines changed

.github/CONTRIBUTING.md

+6-5
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-audacity/edit/master/readme-vars.yml).
27+
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-audacity/edit/main/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-audacity)
@@ -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-audacity.git
101101
cd docker-audacity
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-audacity/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-audacity/tree/main/root), add an entry to the changelog
118119

119120
```yml
120121
changelogs:

.github/PULL_REQUEST_TEMPLATE.md

+1-1
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-audacity/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-audacity/blob/main/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
2525

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

.github/workflows/external_trigger.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
fi
1919
echo "**** External trigger running off of main branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_AUDACITY_MAIN\". ****"
2020
echo "**** Retrieving external version ****"
21-
EXT_RELEASE=$(curl -sX GET https://api.github.com/repos/audacity/audacity/releases/latest | jq -r '.tag_name' | sed 's|^Audacity-||')
21+
EXT_RELEASE=$(curl -u ${{ secrets.CR_USER }}:${{ secrets.CR_PAT }} -sX GET https://api.github.com/repos/audacity/audacity/releases/latest | jq -r '.tag_name' | sed 's|^Audacity-||')
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 audacity branch main"

.github/workflows/greetings.yml

+2-2
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-audacity/blob/master/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-audacity/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-audacity/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-audacity/blob/main/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-audacity/blob/main/.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-audacity/blob/main/.github/PULL_REQUEST_TEMPLATE.md)!'
1313
repo-token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.jenkins-external

README.md

+31-27
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-audacity/blob/main/.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,15 @@ The architectures supported by this image are:
5657
| arm64 | arm64v8-latest |
5758
| armhf | arm32v7-latest |
5859

60+
## Application Setup
61+
62+
The application can be accessed at:
63+
64+
* http://yourhost:3000/
65+
66+
By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:
67+
68+
* http://yourhost:3000/?login=true
5969

6070
## Usage
6171

@@ -85,7 +95,7 @@ services:
8595
8696
### docker cli
8797
88-
```
98+
```bash
8999
docker run -d \
90100
--name=audacity \
91101
-e PUID=1000 \
@@ -97,7 +107,6 @@ docker run -d \
97107
ghcr.io/linuxserver/audacity
98108
```
99109

100-
101110
## Parameters
102111

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

117126
As an example:
118127

119-
```
128+
```bash
120129
-e FILE__PASSWORD=/run/secrets/mysecretpassword
121130
```
122131

@@ -135,30 +144,17 @@ Ensure any volume directories on the host are owned by the same user you specify
135144

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

138-
```
147+
```bash
139148
$ id username
140149
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
141150
```
142151

143-
144-
&nbsp;
145-
## Application Setup
146-
147-
The application can be accessed at:
148-
149-
* http://yourhost:3000/
150-
151-
By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:
152-
153-
* http://yourhost:3000/?login=true
154-
155-
156152
## Docker Mods
153+
157154
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=audacity&query=%24.mods%5B%27audacity%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=audacity "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.")
158155

159156
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.
160157

161-
162158
## Support Info
163159

164160
* Shell access whilst the container is running: `docker exec -it audacity /bin/bash`
@@ -175,38 +171,45 @@ Most of our images are static, versioned, and require an image update and contai
175171
Below are the instructions for updating containers:
176172

177173
### Via Docker Compose
174+
178175
* Update all images: `docker-compose pull`
179176
* or update a single image: `docker-compose pull audacity`
180177
* Let compose update all containers as necessary: `docker-compose up -d`
181178
* or update a single container: `docker-compose up -d audacity`
182179
* You can also remove the old dangling images: `docker image prune`
183180

184181
### Via Docker Run
182+
185183
* Update the image: `docker pull ghcr.io/linuxserver/audacity`
186184
* Stop the running container: `docker stop audacity`
187185
* Delete the container: `docker rm audacity`
188186
* 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)
189187
* You can also remove the old dangling images: `docker image prune`
190188

191189
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
190+
192191
* Pull the latest image at its tag and replace it with the same env variables in one run:
193-
```
192+
193+
```bash
194194
docker run --rm \
195195
-v /var/run/docker.sock:/var/run/docker.sock \
196196
containrrr/watchtower \
197197
--run-once audacity
198198
```
199+
199200
* You can also remove the old dangling images: `docker image prune`
200201

201202
**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).
202203

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

206208
## Building locally
207209

208210
If you want to make local modifications to these images for development purposes or just to customize the logic:
209-
```
211+
212+
```bash
210213
git clone https://github.com/linuxserver/docker-audacity.git
211214
cd docker-audacity
212215
docker build \
@@ -216,7 +219,8 @@ docker build \
216219
```
217220

218221
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
219-
```
222+
223+
```bash
220224
docker run --rm --privileged multiarch/qemu-user-static:register --reset
221225
```
222226

0 commit comments

Comments
 (0)