Bot Updating Templated Files

2019-02-12 09:30:16 -05:00 · 2019-02-12 09:30:16 -05:00 · 67499409ab
commit 67499409ab
--- a/images/docker-tautulli.md
+++ b/images/docker-tautulli.md
@ -1,129 +1,154 @@
-[linuxserverurl]: https://linuxserver.io
-[forumurl]: https://forum.linuxserver.io
-[ircurl]: https://www.linuxserver.io/irc/
-[podcasturl]: https://www.linuxserver.io/podcast/
-[appurl]: http://tautulli.com
-[dockerfileurl]: https://github.com/linuxserver/docker-tautulli/blob/master/Dockerfile
-[hub]: https://hub.docker.com/r/linuxserver/tautulli/
+# [linuxserver/tautulli](https://github.com/linuxserver/docker-tautulli)

+[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
+[![](https://images.microbadger.com/badges/version/linuxserver/tautulli.svg)](https://microbadger.com/images/linuxserver/tautulli "Get your own version badge on microbadger.com")
+[![](https://images.microbadger.com/badges/image/linuxserver/tautulli.svg)](https://microbadger.com/images/linuxserver/tautulli "Get your own version badge on microbadger.com")
+![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/tautulli.svg)
+![Docker Stars](https://img.shields.io/docker/stars/linuxserver/tautulli.svg)
+[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-tautulli/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-tautulli/job/master/)
+[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tautulli/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tautulli/latest/index.html)

+[Tautulli](http://tautulli.com) is a python based web application for monitoring, analytics and notifications for Plex Media Server.

-[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png?v=4&s=4000)][linuxserverurl]
+## Supported Architectures

+Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. 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). 

-## Contact information:-
+Simply pulling `linuxserver/tautulli` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

-| Type | Address/Details |
-| :---: | --- |
-| Discord | [Discord](https://discord.gg/YWrKVTn) |
-| IRC | freenode at `#linuxserver.io` more information at:- [IRC][ircurl]
-| Forum | [Linuserver.io forum][forumurl] |
+The architectures supported by this image are:

-&nbsp;
-&nbsp;
+| Architecture | Tag |
+| :----: | --- |
+| x86-64 | amd64-latest |
+| arm64 | arm64v8-latest |
+| armhf | arm32v6-latest |

-The [LinuxServer.io][linuxserverurl] team brings you another image release featuring :-
+## Version Tags

- + regular and timely application updates
- + easy user mappings
- + 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
- + security updates
+This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.

-# linuxserver/tautulli
-[![](https://images.microbadger.com/badges/version/linuxserver/tautulli.svg)](https://microbadger.com/images/linuxserver/tautulli "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/tautulli.svg)](https://microbadger.com/images/linuxserver/tautulli "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/tautulli.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/tautulli.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-tautulli)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-tautulli/)
-
-[![Dockerfile-link](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/Dockerfile-Link-green.png)][dockerfileurl]
-
-[Tautulli][appurl] A python based web application for monitoring, analytics and notifications for Plex Media Server.
-
-[![tautulli](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/tautulli-icon.png)][appurl]
-
-&nbsp;
+| Tag | Description |
+| :----: | --- |
+| latest | Stable Tautulli releases |
+| develop | Built at head of Tautulli nightly branch |

 ## Usage

+Here are some example snippets to help you get started creating a container from this image.
+
+### docker
+
 ```
 docker create \
  --name=tautulli \
-  -v <path to data>:/config \
-  -v <path to plex logs>:/logs:ro \
-  -e PGID=<gid> -e PUID=<uid>  \
-  -e TZ=<timezone> \
+  -e PUID=1001 \
+  -e PGID=1001 \
+  -e TZ=Europe/London \
  -p 8181:8181 \
+  -v <path to data>:/config \
+  -v <path to plex logs>:/logs \
+  --restart unless-stopped \
  linuxserver/tautulli
 ```

-&nbsp;
+
+### docker-compose
+
+Compatible with docker-compose v2 schemas.
+
+```yaml
+---
+version: "2"
+services:
+  tautulli:
+    image: linuxserver/tautulli
+    container_name: tautulli
+    environment:
+      - PUID=1001
+      - PGID=1001
+      - TZ=Europe/London
+    volumes:
+      - <path to data>:/config
+      - <path to plex logs>:/logs
+    ports:
+      - 8181:8181
+    mem_limit: 4096m
+    restart: unless-stopped
+```

 ## Parameters

-The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
-For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
-So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
-http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
-
+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.

+### Ports (`-p`)

 | Parameter | Function |
-| :---: | --- |
-| `-p 8181` | Port for webui |
-| `-v /config` | Contains tautulli config and database |
-| `-v /logs` | Map this to Plex log directory - recommended RO |
-| `-e PGID` | for GroupID, see below for explanation |
-| `-e PUID` | for UserID, see below for explanation |
-| `-e TZ` | for setting timezone information, eg Europe/London |
+| :----: | --- |
+| `8181` | WebUI |
+
+
+### Environment Variables (`-e`)
+
+| Env | Function |
+| :----: | --- |
+| `PUID=1001` | for UserID - see below for explanation |
+| `PGID=1001` | for GroupID - see below for explanation |
+| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
+
+### Volume Mappings (`-v`)
+
+| Volume | Function |
+| :----: | --- |
+| `/config` | Contains tautulli config and database. |
+| `/logs` | Map this to Plex log directory - recommended RO. |
+

-&nbsp;

 ## User / Group Identifiers

-Sometimes 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 it will "just work" &trade;.
+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=1001` and `PGID=1001`, to find yours use `id user` as below:

 ```
-  $ id <dockeruser>
+  $ id username
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
 ```

-&nbsp;
+## Application Setup

-## Setting up the application
-Access the webui at `<your-ip>:8181`, for more information check out [Tautulli][appurl].
+Access the webui at `<your-ip>:8181`, for more information check out [Tautulli](http://tautulli.com).
 In tautulli gui settings, under `Plex Media Server`, turn on `Show Advanced` and set the `Logs Folder` to `/logs`

-&nbsp;

-## Container access and information.

-| Function | Command |
-| :--- | :--- |
-| Shell access (live container) | `docker exec -it tautulli /bin/bash` |
-| Realtime container logs | `docker logs -f tautulli` |
-| Container version | `docker inspect -f '{{ index .Config.Labels "build_version" }}' tautulli` |
-| Image version |  `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/tautulli` |
-| Dockerfile | [Dockerfile][dockerfileurl] |
+## Support Info

-&nbsp;
+* Shell access whilst the container is running: 
+  * `docker exec -it tautulli /bin/bash`
+* To monitor the logs of the container in realtime: 
+  * `docker logs -f tautulli`
+* Container version number 
+  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' tautulli`
+* Image version number
+  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/tautulli`

-## Changelog
+## Versions

-|  Date | Changes |
-| :---: | --- |
-| 23.10.18 | Add pipeline logic and multi arch. |
-| 23.10.18 | Update plex logs info in readme. |
-| 16.08.18 | Rebase to alpine 3.8. |
-| 10.03.18 | Rebrand to tautulli. |
-| 12.12.17 | Rebase to alpine 3.7. |
-| 21.07.17 | Internal git pull instead of at runtime. |
-| 12.07.17 | Add inspect commands to README, move to jenkins build and push. |
-| 25.05.17 | Rebase to alpine 3.6. |
-| 20.04.17 | Add pycryptodomex pip package. |
-| 07.02.17 | Rebase to alpine 3.5. |
-| 09.09.16 | Add layer badges to README. |
-| 27.08.16 | Add badges to README. |
-| 08.08.16 | Rebase to alpine linux. |
-| 16.07.15 | Inital Release. |
+* **26.01.19:** - Add pipeline logic and multi arch.
+* **23.10.18:** - Update plex logs info in readm.
+* **16.08.18:** - Rebase to alpine 3.8.
+* **10.03.18:** - Rebrand to tautulli.
+* **12.12.17:** - Rebase to alpine 3.7.
+* **21.07.17:** - Internal git pull instead of at runtime.
+* **12.07.17:** - Add inspect commands to README, move to jenkins build and push.
+* **25.05.17:** - Rebase to alpine 3.6.
+* **20.04.17:** - Add pycryptodomex pip package.
+* **07.02.17:** - Rebase to alpine 3.5.
+* **09.09.16:** - Add layer badges to README.
+* **27.08.16:** - Add badges to README.
+* **08.08.16:** - Rebase to alpine linux.
+* **16.07.15:** - Inital Release.