🎉 Release of add-on Tautulli 3.0.0

This commit is contained in:
Community Hass.io Add-ons Bot 2022-06-10 16:40:20 +00:00
parent badf4f3faf
commit 3aaba2f519
6 changed files with 106 additions and 132 deletions

View file

@ -902,10 +902,10 @@ SOFTWARE.
[tasmoadmin-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [tasmoadmin-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
[tasmoadmin-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [tasmoadmin-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[tasmoadmin-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [tasmoadmin-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[addon-tautulli]: https://github.com/hassio-addons/addon-tautulli/tree/v2.3.0 [addon-tautulli]: https://github.com/hassio-addons/addon-tautulli/tree/v3.0.0
[addon-doc-tautulli]: https://github.com/hassio-addons/addon-tautulli/blob/v2.3.0/README.md [addon-doc-tautulli]: https://github.com/hassio-addons/addon-tautulli/blob/v3.0.0/README.md
[tautulli-issue]: https://github.com/hassio-addons/addon-tautulli/issues [tautulli-issue]: https://github.com/hassio-addons/addon-tautulli/issues
[tautulli-version-shield]: https://img.shields.io/badge/version-v2.3.0-blue.svg [tautulli-version-shield]: https://img.shields.io/badge/version-v3.0.0-blue.svg
[tautulli-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [tautulli-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[tautulli-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [tautulli-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[tautulli-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [tautulli-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg

View file

@ -1,25 +1,72 @@
## Whats changed ## Whats changed
## 🐛 Bug fixes This is a major release of the add-on, partially rewriting its base.
It simplified things a lot, takes it into a working state; but has breaking changes.
- Fix wheels link @frenck (#143) ## 🚨 Breaking changes
- Bump wheels link again @frenck (#153)
Username & Password are now managed via the Tautulli interface, the add-on options related to authentication have thus been removed.
Using SSL certificates with this add-on is no longer possible. If you want to use SSL, we recommend using a proxy to add/offload the addition of SSL to this add-on.
The use of a database located in `/share/tautulli` has been removed.
- 🔨Rewrite of add-on @frenck (#214)
## 🚀 Enhancements ## 🚀 Enhancements
- Change add-on startup to application level @frenck (#152) - Migrate JSON config to YAML @frenck (#186)
## 🧰 Maintenance
- 🚀 Add-on CI improvements @frenck (#162)
- Switch to centralized GitHub Action Workflows @frenck (#185)
- 🚀 Update CI to latest version @frenck (#192)
- Replace and/or remove refrences to ludeeus @ludeeus (#210)
## 📚 Documentation
- 🚑 Fix contributing link in readme @frenck (#163)
- 📚 Fix maintenance shield @frenck (#215)
## ⬆️ Dependency updates ## ⬆️ Dependency updates
- ⬆️ Bump docker/setup-qemu-action from 1.1.0 to 1.2.0 @dependabot (#137) - ⬆️ Bump docker/setup-buildx-action from 1.4.1 to 1.5.0 @dependabot (#154)
- ⬆️ Bump docker/build-push-action from 2.4.0 to 2.5.0 @dependabot (#136) - ⬆️ Bump dessant/lock-threads from 2.0.3 to 2.1.1 @dependabot (#156)
- ⬆️ Bump actions/cache from 2.1.5 to 2.1.6 @dependabot (#138) - ⬆️ Bump docker/setup-buildx-action from 1.5.0 to 1.5.1 @dependabot (#157)
- ⬆️ Bump frenck/action-addon-information from 1.1 to 1.2.2 @dependabot (#140) - ⬆️ Bump frenck/action-addon-linter from 2.1 to 2.2 @dependabot (#159)
- ⬆️ Bump plexapi from 4.5.2 to 4.6.0 @dependabot (#141) - ⬆️ Bump actions/stale from 3.0.19 to 4 @dependabot (#158)
- ⬆️ Upgrades add-on base image to v9.2.2 @frenck (#142) - ⬆️ Upgrades Tautulli to v2.7.5 @frenck (#160)
- ⬆️ Bump plexapi from 4.6.0 to 4.6.1 in /tautulli @dependabot (#144) - ⬆️ Bump plexapi from 4.6.1 to 4.7.0 @dependabot (#161)
- ⬆️ Bump docker/build-push-action from 2.5.0 to 2.6.1 @dependabot (#148) - ⬆️ Bump dessant/lock-threads from 2.1.1 to 2.1.2 @dependabot (#164)
- ⬆️ Bump docker/setup-buildx-action from 1.3.0 to 1.4.1 @dependabot (#147) - ⬆️ Bump docker/build-push-action from 2.6.1 to 2.7.0 @dependabot (#165)
- ⬆️ Bump docker/login-action from 1.9.0 to 1.10.0 @dependabot (#146) - ⬆️ Bump frenck/action-addon-linter from 2.2 to 2.3 @dependabot (#166)
- ⬆️ Upgrades add-on base image to v10.0.0 @frenck (#150) - ⬆️ Bump plexapi from 4.7.0 to 4.7.1 in /tautulli @dependabot (#171)
- ⬆️ Upgrades Tautulli to v2.7.4 @frenck (#151) - ⬆️ Bump pycryptodomex from 3.10.1 to 3.10.4 in /tautulli @dependabot (#172)
- ⬆️ Bump frenck/action-addon-linter from 2.3 to 2.4.1 @dependabot (#176)
- ⬆️ Bump pyopenssl from 20.0.1 to 21.0.0 in /tautulli @dependabot (#175)
- ⬆️ Bump plexapi from 4.7.1 to 4.7.2 in /tautulli @dependabot (#177)
- ⬆️ Bump docker/setup-buildx-action from 1.5.1 to 1.6.0 @dependabot (#169)
- ⬆️ Bump creyD/prettier_action from 3.3 to 4.0 @dependabot (#170)
- ⬆️ Bump pycryptodomex from 3.10.4 to 3.11.0 in /tautulli @dependabot (#179)
- ⬆️ Bump actions/checkout from 2.3.4 to 2.3.5 @dependabot (#180)
- ⬆️ Upgrades add-on base image to 10.1.0 @frenck (#184)
- ⬆️ Upgrades add-on base image to 10.2.1 @frenck (#187)
- ⬆️ Upgrades add-on base image to 10.2.2 @frenck (#188)
- ⬆️ Upgrades Tautulli to v2.7.7 @frenck (#189)
- ⬆️ Bump plexapi from 4.7.2 to 4.8.0 in /tautulli @dependabot (#190)
- ⬆️ Upgrades add-on base image to 11.0.0 @frenck (#193)
- ⬆️ Upgrades add-on base image to 11.0.0 @frenck (#194)
- ⬆️ Upgrades Tautulli to v2.8.0 @frenck (#195)
- ⬆️ Upgrades Tautulli to v2.8.1 @frenck (#197)
- ⬆️ Bump pycryptodomex from 3.11.0 to 3.13.0 in /tautulli @dependabot (#199)
- ⬆️ Bump plexapi from 4.8.0 to 4.9.0 in /tautulli @dependabot (#198)
- ⬆️ Bump plexapi from 4.9.0 to 4.9.1 in /tautulli @dependabot (#200)
- ⬆️ Bump pycryptodomex from 3.13.0 to 3.14.0 in /tautulli @dependabot (#202)
- ⬆️ Bump pyopenssl from 21.0.0 to 22.0.0 in /tautulli @dependabot (#201)
- ⬆️ Bump pycryptodomex from 3.14.0 to 3.14.1 in /tautulli @dependabot (#203)
- ⬆️ Bump plexapi from 4.9.1 to 4.9.2 in /tautulli @dependabot (#204)
- ⬆️ Bump plexapi from 4.9.2 to 4.10.1 in /tautulli @dependabot (#207)
- ⬆️ Bump plexapi from 4.10.1 to 4.11.1 in /tautulli @dependabot (#212)
- ⬆️ Bump plexapi from 4.11.1 to 4.11.2 in /tautulli @dependabot (#213)
- 🔨Rewrite of add-on @frenck (#214)

View file

@ -13,8 +13,12 @@ which makes it easy to brag about your server to everyone else.
The installation of this add-on is pretty straightforward and not different in The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Home Assistant add-on. comparison to installing any other Home Assistant add-on.
1. Search for the "Tautulli" add-on in the Supervisor add-on store 1. Click the Home Assistant My button below to open the add-on on your Home
and install it. Assistant instance.
[![Open this add-on in your Home Assistant instance.][addon-badge]][addon]
1. Click the "Install" button to install the add-on.
1. Start the "Tautulli" add-on 1. Start the "Tautulli" add-on
1. Check the logs of the "Tautulli" add-on to see if everything went well. 1. Check the logs of the "Tautulli" add-on to see if everything went well.
1. Click "OPEN WEB UI" to open the Tautulli website and follow the wizard. 1. Click "OPEN WEB UI" to open the Tautulli website and follow the wizard.
@ -30,15 +34,8 @@ Example add-on configuration:
```yaml ```yaml
log_level: info log_level: info
username: MarryPoppins
password: Supercalifragilisticexpialidocious
ssl: true
certfile: fullchain.pem
keyfile: privkey.pem
``` ```
**Note**: _This is just an example, don't copy and past it! Create your own!_
### Option: `log_level` ### Option: `log_level`
The `log_level` option controls the level of log output by the addon and can The `log_level` option controls the level of log output by the addon and can
@ -57,46 +54,6 @@ more severe level, e.g., `debug` also shows `info` messages. By default,
the `log_level` is set to `info`, which is the recommended setting unless the `log_level` is set to `info`, which is the recommended setting unless
you are troubleshooting. you are troubleshooting.
### Option: `username`
Username for authenticating with the Tautulli interface.
Setting a username/password can be added as an extra line of defense,
to prevent users from using your installation for themselves.
This option is HIGHLY recommended in case you expose this add-on to the outside
world.
### Option: `password`
Password for authenticating with Tautulli interface.
### Option: `ssl`
Enables/Disables SSL (HTTPS) on the web interface of Tautulli. Set it `true`
to enable it, `false` otherwise.
### Option: `certfile`
The certificate file to use for SSL.
**Note**: _The file MUST be stored in `/ssl/`, which is the default_
### Option: `keyfile`
The private key file to use for SSL.
**Note**: _The file MUST be stored in `/ssl/`, which is the default_
### Option: `leave_front_door_open`
Adding this option to the add-on configuration allows you to disable
authentication on the add-on by setting it to `true` and leaving the
username and password empty.
**Note**: _We STRONGLY suggest, not to use this, even if this add-on is
only exposed to your internal network. USE AT YOUR OWN RISK!_
## Embedding into Home Assistant ## Embedding into Home Assistant
It is possible to embed Tautulli directly into Home Assistant, allowing you to It is possible to embed Tautulli directly into Home Assistant, allowing you to
@ -114,17 +71,6 @@ panel_iframe:
url: http://addres.to.your.home.assistant:8181 url: http://addres.to.your.home.assistant:8181
``` ```
## Use an existing database
**NB!: This is considered advanced usage.**
If you want to import an existing Tautulli database to this addon, you first
need to extract the `tautulli.db` file from your existing installation.
Place this file in this directory `/share/tautulli`, you can use samba,
Cloud9 or any other method to move it there.
You need to restart the add-on for it to start using this database.
_if the directory `/share/tautulli` does not exist you need to create it._
## Changelog & Releases ## Changelog & Releases
This repository keeps a change log using [GitHub's releases][releases] This repository keeps a change log using [GitHub's releases][releases]
@ -164,7 +110,8 @@ check [the contributor's page][contributors].
MIT License MIT License
Copyright (c) 2018-2021 Joakim Sørensen - Copyright (c) 2018-2019 Joakim Sørensen
- Copyright (c) 2019-2022 Franck Nijhof
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
@ -184,10 +131,12 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_tautulli&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
[contributors]: https://github.com/hassio-addons/addon-tautulli/graphs/contributors [contributors]: https://github.com/hassio-addons/addon-tautulli/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e [discord-ha]: https://discord.gg/c5DvZ4e
[discord]: https://discord.me/hassioaddons [discord]: https://discord.me/hassioaddons
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tautulli/68745?u=ludeeus [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tautulli/68745
[issue]: https://github.com/hassio-addons/addon-tautulli/issues [issue]: https://github.com/hassio-addons/addon-tautulli/issues
[ludeeus]: https://github.com/ludeeus [ludeeus]: https://github.com/ludeeus
[reddit]: https://reddit.com/r/homeassistant [reddit]: https://reddit.com/r/homeassistant

View file

@ -4,8 +4,6 @@
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] [![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
Monitoring and tracking tool for Plex Media Server. Monitoring and tracking tool for Plex Media Server.
![Screenshot][screenshot] ![Screenshot][screenshot]
@ -37,14 +35,12 @@ If you are more interested in stable releases of our add-ons:
<https://github.com/hassio-addons/repository> <https://github.com/hassio-addons/repository>
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/ludeeus
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg [discord-shield]: https://img.shields.io/discord/330944238910963714.svg
[discord]: https://discord.gg/c5DvZ4e [discord]: https://discord.gg/c5DvZ4e
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tautulli/68745?u=ludeeus [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tautulli/68745
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg [maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[release-shield]: https://img.shields.io/badge/version-v2.3.0-blue.svg [release-shield]: https://img.shields.io/badge/version-v3.0.0-blue.svg
[release]: https://github.com/hassio-addons/addon-tautulli/tree/v2.3.0 [release]: https://github.com/hassio-addons/addon-tautulli/tree/v3.0.0
[screenshot]: https://github.com/hassio-addons/addon-tautulli/raw/main/images/screenshot.png [screenshot]: https://github.com/hassio-addons/addon-tautulli/raw/main/images/screenshot.png

View file

@ -1,43 +0,0 @@
{
"name": "Tautulli",
"version": "2.3.0",
"slug": "tautulli",
"description": "Monitoring and tracking tool for Plex Media Server",
"url": "https://github.com/hassio-addons/addon-tautulli/tree/main/README.md",
"webui": "[PROTO:ssl]://[HOST]:[PORT:8181]",
"arch": [
"aarch64",
"amd64",
"armhf",
"armv7",
"i386"
],
"hassio_api": true,
"ports": {
"8181/tcp": 8181
},
"ports_description": {
"8181/tcp": "Tautulli web interface"
},
"map": [
"ssl",
"share:rw"
],
"options": {
"username": "",
"password": "",
"ssl": true,
"certfile": "fullchain.pem",
"keyfile": "privkey.pem"
},
"schema": {
"log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
"username": "str",
"password": "password",
"ssl": "bool",
"certfile": "str",
"keyfile": "str",
"leave_front_door_open": "bool?"
},
"image": "ghcr.io/hassio-addons/tautulli/{arch}"
}

25
tautulli/config.yaml Normal file
View file

@ -0,0 +1,25 @@
arch:
- aarch64
- amd64
- armhf
- armv7
- i386
codenotary: codenotary@frenck.dev
description: Monitoring and tracking tool for Plex Media Server
hassio_api: true
image: ghcr.io/hassio-addons/tautulli/{arch}
init: false
map:
- share:rw
- backup:rw
name: Tautulli
ports:
8181/tcp: 8181
ports_description:
8181/tcp: Tautulli web interface
schema:
log_level: list(trace|debug|info|notice|warning|error|fatal)?
slug: tautulli
url: https://github.com/hassio-addons/addon-tautulli/tree/main/README.md
version: 3.0.0
webui: '[PROTO:ssl]://[HOST]:[PORT:8181]'