Bot Updating Documentation

docs/images/docker-limnoria.md

@@ -2,8 +2,7 @@
 title: limnoria
 ---
 <!-- DO NOT EDIT THIS FILE MANUALLY -->
-<!-- Please read the https://github.com/linuxserver/docker-limnoria/blob/master/.github/CONTRIBUTING.md -->
+<!-- Please read https://github.com/linuxserver/docker-limnoria/blob/master/.github/CONTRIBUTING.md -->
-
 # [linuxserver/limnoria](https://github.com/linuxserver/docker-limnoria)
 
 [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Flimnoria?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Flimnoria)
@@ -19,6 +18,8 @@ title: limnoria
 
 [Limnoria](https://github.com/ProgVal/limnoria) A robust, full-featured, and user/programmer-friendly Python IRC bot, with many existing plugins. Successor of the well-known Supybot.
 
+[![limnoria](https://raw.githubusercontent.com/linuxserver/docker-limnoria/master/logo.png)](https://github.com/ProgVal/limnoria)
+
 ## Supported Architectures
 
 We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
@@ -103,12 +104,11 @@ docker run -d \
   -v path/to/config:/config \
   --restart unless-stopped \
   lscr.io/linuxserver/limnoria:latest
-
 ```
 
 ## Parameters
 
-Docker 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.
 
 ### Ports (`-p`)
 
@@ -142,10 +142,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
 
@@ -158,11 +158,16 @@ When using volumes (`-v` flags), permissions issues can arise between the host O
 
 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
+id your_user
-    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
+```
+
+Example output:
+
+```text
+uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 ```
 
 ## Docker Mods
@@ -174,13 +179,139 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
 ## Support Info
 
 * Shell access whilst the container is running:
-  * `docker exec -it limnoria /bin/bash`
+
+    ```bash
+    docker exec -it limnoria /bin/bash
+    ```
+
 * To monitor the logs of the container in realtime:
-  * `docker logs -f limnoria`
+
-* Container version number
+    ```bash
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' limnoria`
+    docker logs -f limnoria
-* Image version number
+    ```
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/limnoria:latest`
+
+* Container version number:
+
+    ```bash
+    docker inspect -f '{{ index .Config.Labels "build_version" }}' limnoria
+    ```
+
+* Image version number:
+
+    ```bash
+    docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/limnoria:latest
+    ```
+
+## Updating Info
+
+Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
+
+Below are the instructions for updating containers:
+
+### Via Docker Compose
+
+* Update images:
+    * All images:
+
+        ```bash
+        docker-compose pull
+        ```
+
+    * Single image:
+
+        ```bash
+        docker-compose pull limnoria
+        ```
+
+* Update containers:
+    * All containers:
+
+        ```bash
+        docker-compose up -d
+        ```
+
+    * Single container:
+
+        ```bash
+        docker-compose up -d limnoria
+        ```
+
+* You can also remove the old dangling images:
+
+    ```bash
+    docker image prune
+    ```
+
+### Via Docker Run
+
+* Update the image:
+
+    ```bash
+    docker pull lscr.io/linuxserver/limnoria:latest
+    ```
+
+* Stop the running container:
+
+    ```bash
+    docker stop limnoria
+    ```
+
+* Delete the container:
+
+    ```bash
+    docker rm limnoria
+    ```
+
+* 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:
+
+    ```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 limnoria
+    ```
+
+* You can also remove the old dangling images: `docker image prune`
+
+!!! 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)
+
+!!! 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
+
+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-limnoria.git
+cd docker-limnoria
+docker build \
+  --no-cache \
+  --pull \
+  -t lscr.io/linuxserver/limnoria:latest .
+```
+
+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`.
 
 ## Versions