Bot Updating Templated Files

2024-11-09 23:24:08 -08:00 · 2023-10-10 17:28:47 +00:00 · 2023-10-10 17:28:47 +00:00 · 97f49ac5c4
parent fec1cf2627
commit 97f49ac5c4
1 changed files with 100 additions and 35 deletions
--- a/README.md
+++ b/README.md
@ -1,6 +1,5 @@
-<!-- DO NOT EDIT THIS FILE MANUALLY  -->
-<!-- Please read the https://github.com/linuxserver/docker-unifi-network-application/blob/main/.github/CONTRIBUTING.md -->
-
+<!-- DO NOT EDIT THIS FILE MANUALLY -->
+<!-- Please read https://github.com/linuxserver/docker-unifi-network-application/blob/main/.github/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!")
@ -129,7 +128,7 @@ If you are using a reverse proxy which validates certificates, you need to [disa

 ## Usage

-Here are some example snippets to help you get started creating a container.
+To help you get started creating a container from this image you can either use docker-compose or the docker cli.

 ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))

@ -193,12 +192,11 @@ docker run -d \
  -v /path/to/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/unifi-network-application:latest
-
 ```

 ## 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.
+Containers 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.

 | Parameter | Function |
 | :----: | --- |
@ -230,10 +228,10 @@ 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
+-e FILE__MYVAR=/run/secrets/mysecretvariable
 ```

-Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
+Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.

 ## Umask for running applications

@ -242,15 +240,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu

 ## User / Group Identifiers

-When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
+When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.

 Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

-In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
+In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:

 ```bash
-  $ id username
-    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
+id your_user
+```
+
+Example output:
+
+```text
+uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 ```

 ## Docker Mods
@ -261,12 +264,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to

 ## Support Info

-* Shell access whilst the container is running: `docker exec -it unifi-network-application /bin/bash`
-* To monitor the logs of the container in realtime: `docker logs -f unifi-network-application`
-* container version number
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi-network-application`
-* image version number
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/unifi-network-application:latest`
+* Shell access whilst the container is running:
+
+    ```bash
+    docker exec -it unifi-network-application /bin/bash
+    ```
+
+* To monitor the logs of the container in realtime:
+
+    ```bash
+    docker logs -f unifi-network-application
+    ```
+
+* Container version number:
+
+    ```bash
+    docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi-network-application
+    ```
+
+* Image version number:
+
+    ```bash
+    docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/unifi-network-application:latest
+    ```

 ## Updating Info

@ -276,38 +296,83 @@ Below are the instructions for updating containers:

 ### Via Docker Compose

-* Update all images: `docker-compose pull`
-  * or update a single image: `docker-compose pull unifi-network-application`
-* Let compose update all containers as necessary: `docker-compose up -d`
-  * or update a single container: `docker-compose up -d unifi-network-application`
-* You can also remove the old dangling images: `docker image prune`
+* Update images:
+    * All images:
+
+        ```bash
+        docker-compose pull
+        ```
+
+    * Single image:
+
+        ```bash
+        docker-compose pull unifi-network-application
+        ```
+
+* Update containers:
+    * All containers:
+
+        ```bash
+        docker-compose up -d
+        ```
+
+    * Single container:
+
+        ```bash
+        docker-compose up -d unifi-network-application
+        ```
+
+* You can also remove the old dangling images:
+
+    ```bash
+    docker image prune
+    ```

 ### Via Docker Run

-* Update the image: `docker pull lscr.io/linuxserver/unifi-network-application:latest`
-* Stop the running container: `docker stop unifi-network-application`
-* Delete the container: `docker rm unifi-network-application`
+* Update the image:
+
+    ```bash
+    docker pull lscr.io/linuxserver/unifi-network-application:latest
+    ```
+
+* Stop the running container:
+
+    ```bash
+    docker stop unifi-network-application
+    ```
+
+* Delete the container:
+
+    ```bash
+    docker rm unifi-network-application
+    ```
+
 * 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`
+* You can also remove the old dangling images:
+
+    ```bash
+    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 unifi-network-application
-  ```
+    ```bash
+    docker run --rm \
+      -v /var/run/docker.sock:/var/run/docker.sock \
+      containrrr/watchtower \
+      --run-once unifi-network-application
+    ```

 * 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).
+**warning**: 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.
+**tip**: We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

 ## Building locally