Bot Updating Templated Files

2020-10-09 07:32:59 -04:00
parent 021144ce22
commit 4f31e06cba
5 changed files with 87 additions and 51 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,6 @@
+<!-- DO NOT EDIT THIS FILE MANUALLY  -->
+<!-- Please read the CONTRIBUTING.md -->
+
 [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)

 [![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!")
@ -58,10 +61,34 @@ The architectures supported by this image are:

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

-### docker
+### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
+
+Compatible with docker-compose v2 schemas.
+
+```yaml
+---
+version: "2.1"
+services:
+  oscam:
+    image: linuxserver/oscam
+    container_name: oscam
+    environment:
+      - PUID=1000
+      - PGID=1000
+      - TZ=Europe/London
+    volumes:
+      - <path to data>:/config
+    ports:
+      - 8888:8888
+    devices:
+      - /dev/ttyUSB0:/dev/ttyUSB0
+    restart: unless-stopped
+```
+
+### docker cli

 ```
-docker create \
+docker run -d \
  --name=oscam \
  -e PUID=1000 \
  -e PGID=1000 \
@ -95,30 +122,6 @@ The first number, the Bus, is 002. The second number, the Device, is 005. This w
 If you have multiple smart card readers, you add one `--device=` tag for each reader.


-### docker-compose
-
-Compatible with docker-compose v2 schemas.
-
-```
---
-version: "2.1"
-services:
-  oscam:
-    image: linuxserver/oscam
-    container_name: oscam
-    environment:
-      - PUID=1000
-      - PGID=1000
-      - TZ=Europe/London
-    volumes:
-      - <path to data>:/config
-    ports:
-      - 8888:8888
-    devices:
-      - /dev/ttyUSB0:/dev/ttyUSB0
-    restart: unless-stopped
-```
-
 ## 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.
@ -171,9 +174,9 @@ The web interface is at port 8888.


 ## Docker Mods
-[![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%27oscam%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=oscam "view available mods for this container.")
+[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=oscam&query=%24.mods%5B%27oscam%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=oscam "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) can be accessed via the dynamic badge above.
+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
@ -191,14 +194,6 @@ Most of our images are static, versioned, and require an image update and contai

 Below are the instructions for updating containers:

-### Via Docker Run/Create
-* Update the image: `docker pull linuxserver/oscam`
-* Stop the running container: `docker stop oscam`
-* Delete the container: `docker rm oscam`
-* 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)
-* Start the new container: `docker start oscam`
-* You can also remove the old dangling images: `docker image prune`
-
 ### Via Docker Compose
 * Update all images: `docker-compose pull`
  * or update a single image: `docker-compose pull oscam`
@ -206,7 +201,14 @@ Below are the instructions for updating containers:
  * or update a single container: `docker-compose up -d oscam`
 * You can also remove the old dangling images: `docker image prune`

-### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
+### Via Docker Run
+* Update the image: `docker pull linuxserver/oscam`
+* Stop the running container: `docker stop oscam`
+* Delete the container: `docker rm oscam`
+* 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:
  ```
  docker run --rm \
@ -214,11 +216,13 @@ Below are the instructions for updating containers:
  containrrr/watchtower \
  --run-once oscam
  ```
-
-**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.
-
 * 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: