From 3ced96ed68b76db843f260fd4863552ddf3ae354 Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Sat, 30 May 2020 18:15:45 +0000 Subject: [PATCH] :tada: Release of add-on Tautulli 1.5.1 --- README.md | 6 +- tautulli/CHANGELOG.md | 20 ++-- tautulli/DOCS.md | 209 ++++++++++++++++++++++++++++++++++++++++++ tautulli/README.md | 7 +- tautulli/config.json | 2 +- 5 files changed, 224 insertions(+), 20 deletions(-) create mode 100644 tautulli/DOCS.md diff --git a/README.md b/README.md index 9231b388..8f9cc2a9 100644 --- a/README.md +++ b/README.md @@ -1090,10 +1090,10 @@ SOFTWARE. [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-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-tautulli]: https://github.com/hassio-addons/addon-tautulli/tree/v1.5.0 -[addon-doc-tautulli]: https://github.com/hassio-addons/addon-tautulli/blob/v1.5.0/README.md +[addon-tautulli]: https://github.com/hassio-addons/addon-tautulli/tree/v1.5.1 +[addon-doc-tautulli]: https://github.com/hassio-addons/addon-tautulli/blob/v1.5.1/README.md [tautulli-issue]: https://github.com/hassio-addons/addon-tautulli/issues -[tautulli-version-shield]: https://img.shields.io/badge/version-v1.5.0-blue.svg +[tautulli-version-shield]: https://img.shields.io/badge/version-v1.5.1-blue.svg [tautulli-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/tautulli.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 diff --git a/tautulli/CHANGELOG.md b/tautulli/CHANGELOG.md index 0731329c..377628df 100644 --- a/tautulli/CHANGELOG.md +++ b/tautulli/CHANGELOG.md @@ -1,16 +1,14 @@ ## Changes -- :books: Update add-on documentation to use new YAML configuration format -- :hammer: Re-branding -- :hammer: Update add-on config with new password & list features -- :arrow_up: Upgrades add-on base image to v7.0.2 -- :arrow_up: Updates pycryptodomex to v3.9.7 (#55) -- :ambulance: Fix SSL -- :pencil2: Replace some Hass.io occurances -- :arrow_up: Upgrades Tautulli to v2.1.44 -- :hammer: Update community forum links -- :hammer: Don't use apk cache on cleanup +- ⬆ Upgrades gcc to 9.2.0-r4 +- ⬆ Upgrades git to 2.24.3-r0 +- ⬆ Upgrades add-on base image to v7.2.0 +- ⬆ Upgrades Tautulli to v2.2.4 +- ⬆ Upgrades python2 to 2.7.18-r0 +- 🔨 Implement OCI image specification on labels +- ✏ Split add-on documentation +- ⬆ Updates plexapi to v3.6.0 (#57) [Full Changelog][changelog] -[changelog]: https://github.com/hassio-addons/addon-tautulli/compare/v1.4.0...v1.5.0 \ No newline at end of file +[changelog]: https://github.com/hassio-addons/addon-tautulli/compare/v1.5.0...v1.5.1 \ No newline at end of file diff --git a/tautulli/DOCS.md b/tautulli/DOCS.md new file mode 100644 index 00000000..bb873a8e --- /dev/null +++ b/tautulli/DOCS.md @@ -0,0 +1,209 @@ +# Home Assistant Community Add-on: Tautulli + +Tautulli is an application that you can run alongside your Plex Media Server +to monitor activity, and track various statistics. +Most importantly, these statistics include what has been watched, +who watched it, when and where they watched it, and how it was watched. +All statistics are presented in a nice and clean interface +with many tables and graphs, +which makes it easy to brag about your server to everyone else. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Search for the "Tautulli" add-on in the Supervisor add-on store + and install it. +1. Start the "Tautulli" add-on +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. + +**NOTE**: Starting the add-on might take a couple of minutes (especially the +first time starting the add-on). + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +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` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +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 +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. + +**Note**: _This option support secrets, e.g., `!secret tautulli_username`._ + +### Option: `password` + +Password for authenticating with Tautulli interface. + +**Note**: _This option support secrets, e.g., `!secret tautulli_password`._ + +### 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: `i_like_to_be_pwned` + +Adding this option to the add-on configuration allows to you bypass the +HaveIBeenPwned password requirement by setting it to `true`. + +**Note**: _We STRONGLY suggest picking a stronger/safer password instead of +using this option! USE AT YOUR OWN RISK!_ + +### 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 + +It is possible to embed Tautulli directly into Home Assistant, allowing you to +access your Tautulli through the Home Assistant frontend. + +Home Assistant provides the `panel_iframe` integration, for these purposes. + +Example configuration: + +```yaml +panel_iframe: + tautulli: + title: Tautulli + icon: mdi:filmstrip + 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 + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Joakim Sørensen][ludeeus]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2018-2020 Joakim Sørensen + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +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 +SOFTWARE. + +[contributors]: https://github.com/hassio-addons/addon-tautulli/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tautulli/68745?u=ludeeus +[issue]: https://github.com/hassio-addons/addon-tautulli/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[ludeeus]: https://github.com/ludeeus +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-tautulli/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/tautulli/README.md b/tautulli/README.md index 3b386362..a9c5d839 100644 --- a/tautulli/README.md +++ b/tautulli/README.md @@ -21,17 +21,14 @@ who watched it, when and where they watched it, and how it was watched. All statistics are presented in a nice and clean interface with many tables and graphs, which makes it easy to brag about your server to everyone else. -[Click here for the full documentation][docs] - [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]: https://discord.gg/c5DvZ4e -[docs]: https://github.com/hassio-addons/addon-tautulli/blob/v1.5.0/README.md [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 [maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg -[release-shield]: https://img.shields.io/badge/version-v1.5.0-blue.svg -[release]: https://github.com/hassio-addons/addon-tautulli/tree/v1.5.0 +[release-shield]: https://img.shields.io/badge/version-v1.5.1-blue.svg +[release]: https://github.com/hassio-addons/addon-tautulli/tree/v1.5.1 [screenshot]: https://github.com/hassio-addons/addon-tautulli/raw/master/images/screenshot.png \ No newline at end of file diff --git a/tautulli/config.json b/tautulli/config.json index e40a39c2..399e1b96 100644 --- a/tautulli/config.json +++ b/tautulli/config.json @@ -1,6 +1,6 @@ { "name": "Tautulli", - "version": "1.5.0", + "version": "1.5.1", "slug": "tautulli", "description": "Monitoring and tracking tool for Plex Media Server", "url": "https://github.com/hassio-addons/addon-tautulli/tree/master/README.md",