Bot Updating Templated Files

Author: LinuxServer-CI

.github/CONTRIBUTING.md

@@ -96,7 +96,7 @@ If you are proposing additional packages to be added, ensure that you added the
 
 ### Testing your changes
 
-```
+```bash
 git clone https://github.com/linuxserver/docker-nntp2nntp.git
 cd docker-nntp2nntp
 docker build \
@@ -106,13 +106,14 @@ docker build \
 ```
 
 The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
-```
+
+```bash
 docker run --rm --privileged multiarch/qemu-user-static:register --reset
 ```
 
 Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
 
-## Update the chagelog
+## Update the changelog
 
 If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-nntp2nntp/tree/master/root), add an entry to the changelog
 

README.md

@@ -1,5 +1,5 @@
 <!-- DO NOT EDIT THIS FILE MANUALLY  -->
-<!-- Please read the CONTRIBUTING.md -->
+<!-- Please read the https://github.com/linuxserver/docker-nntp2nntp/blob/master/.github/CONTRIBUTING.md -->
 
 [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
 
@@ -12,13 +12,14 @@
 
 The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
 
- * regular and timely application updates
- * easy user mappings (PGID, PUID)
- * custom base image with s6 overlay
- * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- * regular security updates
+* regular and timely application updates
+* easy user mappings (PGID, PUID)
+* custom base image with s6 overlay
+* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
+* regular security updates
 
 Find us at:
+
 * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
 * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
 * [Discourse](https://discourse.linuxserver.io) - post on our community forum.
@@ -43,7 +44,6 @@ Find us at:
 
 Whilst we know of no nntp2nntp security issues the [upstream code](https://github.com/linuxserver/nntp2nntp) for this project has received no changes since 06.08.15 and is likely abandoned permanently.  For this reason we strongly recommend you do not make this application public facing and if you must do so other layers of security and SSL should be considered an absolute bare minimum requirement.  We see this proxy being used primarily on a LAN so that all the users NNTP applications can share a common set of internal credentials allowing for central managment of the upstream account e.g change provider, server, thread limits for all applications with one global config change.
 
-
 [![nntp2nntp](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/nntp2nntp.png)](https://github.com/linuxserver/nntp2nntp)
 
 ## Supported Architectures
@@ -60,6 +60,20 @@ The architectures supported by this image are:
 | arm64 | arm64v8-latest |
 | armhf | arm32v6-latest |
 
+## Application Setup
+
+Edit sample config file `config/nntp2nntp.conf` with upstream provider details and rename the local users.
+
+New user passwords can be created by running the password hash generator
+```
+docker exec -it nntp2nntp /usr/bin/nntp2nntp.py pass
+```
+entering the desired password and copying the resulting string to the relevant user line in `/config/nntp2nntp.conf`
+
+Example with a user called `Dave` and with a password of `password`
+```
+Dave    = 5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8
+```
 
 ## Usage
 
@@ -91,7 +105,7 @@ services:
 
 ### docker cli
 
-```
+```bash
 docker run -d \
   --name=nntp2nntp \
   -e PUID=1000 \
@@ -105,7 +119,6 @@ docker run -d \
   ghcr.io/linuxserver/nntp2nntp
 ```
 
-
 ## Parameters
 
 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.
@@ -126,7 +139,7 @@ You can set any environment variable from a file by using a special prepend `FIL
 
 As an example:
 
-```
+```bash
 -e FILE__PASSWORD=/run/secrets/mysecretpassword
 ```
 
@@ -145,35 +158,17 @@ Ensure any volume directories on the host are owned by the same user you specify
 
 In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
 
-```
+```bash
   $ id username
     uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
 ```
 
-
-&nbsp;
-## Application Setup
-
-Edit sample config file `config/nntp2nntp.conf` with upstream provider details and rename the local users.
-
-New user passwords can be created by running the password hash generator
-```
-docker exec -it nntp2nntp /usr/bin/nntp2nntp.py pass
-```
-entering the desired password and copying the resulting string to the relevant user line in `/config/nntp2nntp.conf`
-
-Example with a user called `Dave` and with a password of `password`
-```
-Dave    = 5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8
-```
-
-
 ## Docker Mods
+
 [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=nntp2nntp&query=%24.mods%5B%27nntp2nntp%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=nntp2nntp "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.")
 
 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.
 
-
 ## Support Info
 
 * Shell access whilst the container is running: `docker exec -it nntp2nntp /bin/bash`
@@ -190,38 +185,45 @@ Most of our images are static, versioned, and require an image update and contai
 Below are the instructions for updating containers:
 
 ### Via Docker Compose
+
 * Update all images: `docker-compose pull`
   * or update a single image: `docker-compose pull nntp2nntp`
 * Let compose update all containers as necessary: `docker-compose up -d`
   * or update a single container: `docker-compose up -d nntp2nntp`
 * You can also remove the old dangling images: `docker image prune`
 
 ### Via Docker Run
+
 * Update the image: `docker pull ghcr.io/linuxserver/nntp2nntp`
 * Stop the running container: `docker stop nntp2nntp`
 * Delete the container: `docker rm nntp2nntp`
 * 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)
 * You can also remove the old dangling images: `docker image prune`
 
 ### Via Watchtower auto-updater (only use if you don't remember the original parameters)
+
 * Pull the latest image at its tag and replace it with the same env variables in one run:
-  ```
+
+  ```bash
   docker run --rm \
   -v /var/run/docker.sock:/var/run/docker.sock \
   containrrr/watchtower \
   --run-once nntp2nntp
   ```
+
 * You can also remove the old dangling images: `docker image prune`
 
 **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).
 
 ### Image Update Notifications - Diun (Docker Image Update Notifier)
+
 * We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
 
 ## Building locally
 
 If you want to make local modifications to these images for development purposes or just to customize the logic:
-```
+
+```bash
 git clone https://github.com/linuxserver/docker-nntp2nntp.git
 cd docker-nntp2nntp
 docker build \
@@ -231,7 +233,8 @@ docker build \
 ```
 
 The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
-```
+
+```bash
 docker run --rm --privileged multiarch/qemu-user-static:register --reset
 ```