github/plexpy
1
0
Fork 0
mirror of https://github.com/Tautulli/Tautulli.git synced 2025-07-16 02:02:58 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

GitBook: [docs] 13 pages and 2 assets modified

Browse source
This commit is contained in:
JonnyWong16 2021-05-24 06:43:39 +00:00 • committed by gitbook-bot
parent e715b0dc5c
commit 3cc28305ad
No known key found for this signature in database
GPG key ID: 07D2180C7B12D0FF
15 changed files with 5608 additions and 144 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/using-tautulli/3rd-party-apis-guide.md Normal file
View file

@ -0,0 +1,26 @@
# 3rd Party APIs Guide
## 3rd Party APIs:
* [Imgur](3rd-party-apis-guide.md#imgur)
* [Cloudinary](3rd-party-apis-guide.md#cloudinary)
* [MaxMind](3rd-party-apis-guide.md#maxmind)
## [Imgur](3rd-party-apis-guide.md) <a id="imgur"></a>
1. Sign up for an [Imgur account](https://imgur.com/register). Make sure to verify the account.
2. Register a [new application](https://api.imgur.com/oauth2/addclient).
3. Enter an **Application Name**, **Email**, **Description**, and select the option "_OAuth 2 authorization without a callback URL_", then click "_Submit_".
4. Copy the **Client ID** and fill in the Tautulli setting.
## [Cloudinary](3rd-party-apis-guide.md) <a id="cloudinary"></a>
1. Sign up for a [Cloudinary account](https://cloudinary.com/users/register/free). Make sure to verify the account.
2. From the Cloudinary dashboard, copy the **Cloud Name**, **API Key**, and **API Secret** and fill in the Tautulli settings.
## [MaxMind](3rd-party-apis-guide.md) <a id="MaxMind"></a>
Note: The GeoLite2 database is not required for Tautulli v2.2.3 and above. Geolocation lookup is done via Plex.tv.
Legacy instructions for pre-v2.2.3 1. Sign up for a \[MaxMind account\]\(https://www.maxmind.com/en/geolite2/signup\). Make sure to verify the account. 1. Go to your \*Account\*, then \*Services\* &gt; \*My License Key\* in the side menu, then click "\*Generate New License Key\*". 1. Enter a \*\*License key description\*\*, and select "\*No\*" for "\*Will this key be used for GeoIP Update?\*", then click "\*Confirm\*". 1. Copy the \*License Key\* and fill in the Tautulli setting.

63
docs/using-tautulli/custom-notification-conditions.md Normal file
View file

@ -0,0 +1,63 @@
# Custom Notification Conditions
## Overview
Tautulli allows you to define conditions that determine whether or not your Notifications will actually be sent.
The conditions are used to _**allow**_ notifications through. For example:
* Allow notifications through if the `Username` `is` `alice`.
* Allow notifications through if the `Library Name` `is not` `4K Movies`
## Single conditions
The simplest use case is a single condition, allowing you to do things like not show Recently Added notifications for a specific library, or watched notifications for a specific user.
### Excluding a specific user
![image](../.gitbook/assets/excluding_specific_user.png)
### Excluding a specific Library
![image](../.gitbook/assets/excluding_specific_library.png)
### Custom Condition Logic
By default Tautulli uses `AND` to combine multiple conditions together, meaning that all conditions must evaluate to true in order for the notification to send. If you need more complex logic than that you can customize this in the _Condition Logic_ setting.
### Warning on `is not`
Don't try to use multiple `is not` clauses for the same parameter and join them together with an `OR`! This will simply end up with the combination evaluating to `True` every single time.
For example let's say you have this setup: ![image](https://user-images.githubusercontent.com/427137/41248058-a358bde4-6d64-11e8-8c5f-d2153bdf4998.png)
* Play a song from `Music A`:
```text
{1} Library Name is not Music A = False
{2} Library Name is not Music B = True
Condition Logic = {False} or {True} = True = Notification is sent
```
* Play a song from `Music B`:
```text
{1} Library Name is not Music A = True
{2} Library Name is not Music B = False
Condition Logic = {True} or {False} = True = Notification is sent
```
If you want to use `is not` for multiple values simply put both values in the same value list within Tautulli: ![image](https://user-images.githubusercontent.com/427137/41247785-fa722e4a-6d63-11e8-9eae-cc0d07e6b2ad.png)
## Conditions and Triggers
Conditions apply to the entire notification agent, this means that if you want to have some Triggers have one condition \(Recently Added limited by library\) and other Triggers limited by a different condition \(Watched wasn't a specific user\) you need to add different Notification Agents for the different triggers. Tautulli makes this simple to setup by providing a Duplicate button on each Notification Agent's dialog.
### ⚠️ Available properties
Note: Not all properties apply to all triggers!
If you open the list of parameter descriptions the sections will tell you when the properties are available for conditions, but there is nothing in the interface that will prevent you from setting things up incorrectly!
For example, the `{username}` property is only available for things related to a Stream such as the Watched or Playback triggers. It is _not_ available for things that have no stream details, such as the Recently Added trigger. If you set up a condition using a property that isn't available it's likely your notifications won't ever send!

288
docs/using-tautulli/exporter-guide.md Normal file
View file

File diff suppressed because one or more lines are too long

256
docs/using-tautulli/notification-agents-guide.md Normal file
View file

@ -0,0 +1,256 @@
# Notifications Agents Guide
## Notification Agents:
* [Boxcar](notification-agents-guide.md#boxcar)
* [Browser](notification-agents-guide.md#browser)
* [Discord](notification-agents-guide.md#discord)
* [Email](notification-agents-guide.md#email)
* [Facebook](notification-agents-guide.md#facebook)
* [GroupMe](notification-agents-guide.md#groupme)
* [Growl](notification-agents-guide.md#growl)
* [Hipchat](notification-agents-guide.md#hipchat)
* [IFTTT](notification-agents-guide.md#ifttt)
* [Join](notification-agents-guide.md#join)
* [Kodi](notification-agents-guide.md#xbmc)
* [macOS Notification Center](notification-agents-guide.md#osx)
* [MQTT](notification-agents-guide.md#mqtt)
* [Notify My Android](notification-agents-guide.md#nma)
* [Plex Home Theater](notification-agents-guide.md#plex)
* [Plex Android / iOS App](notification-agents-guide.md#plexmobileapp)
* [Prowl](notification-agents-guide.md#prowl)
* [Pushbullet](notification-agents-guide.md#pushbullet)
* [Pushover](notification-agents-guide.md#pushover)
* [Script](notification-agents-guide.md#scripts)
* [Slack](notification-agents-guide.md#slack)
* [Tautulli Remote Android App](notification-agents-guide.md#androidapp)
* [Telegram](notification-agents-guide.md#telegram)
* [Twitter](notification-agents-guide.md#twitter)
* [Webhook](notification-agents-guide.md#webhook)
* [Zapier](notification-agents-guide.md#zapier)
## [Browser](notification-agents-guide.md) <a id="browser"></a>
1. Click on `Allow Notifications` and give permission for Tautulli to send notifications through your browser.
## [Boxcar](notification-agents-guide.md) <a id="boxcar"></a>
1. Go to the Settings page in your Boxcar app.
2. Copy the **Access Token** and fill in the Tautulli setting.
## [Discord](notification-agents-guide.md) <a id="discord"></a>
1. Go to Discord, and click on **Edit Channel** for the channel where you want the notifications to be sent.
2. Go to the **Webhooks** tab and click on **Create Webhook**.
3. Give your webhook bot a **Name** and **Icon**. This can be changed in the Tautulli settings instead if you wish.
4. Copy the **Webhook URL** and fill in the Tautulli setting.
## [Email](notification-agents-guide.md) <a id="email"></a>
* **Note:** Some anti-virus software have "Email protection" which may prevent sending emails via SMTP from a script. This will either need to be disabled or add an exception for Tautulli to send emails.
### Gmail
* **Note:** If you use 2-factor authentication, then you will need to generate an app password [here](https://security.google.com/settings/security/apppasswords).
* **Note:** If you don't use 2-factor authentication, you may need to allow less secure apps to access your account. See Option 2 [here](https://support.google.com/accounts/answer/6010255?hl=en&ref_topic=2401957).
```text
SMTP Server: smtp.gmail.com
SMTP Port: 587 or 465
SMTP User: YourEmail@gmail.com or Username
SMTP Password: Your Gmail password or app password
Encryption: TLS/STARTTLS (587) or SSL/TLS (465)
```
### Outlook.com
* **Note:** If you use 2-factor authentication, then you will need to generate an app password [here](https://account.live.com/proofs/AppPassword).
```text
SMTP Server: smtp.office365.com
SMTP Port: 587
SMTP User: YourEmail@outlook.com
SMTP Password: Your Outlook password or app password
Encryption: TLS/STARTTLS (587)
```
## [Facebook](notification-agents-guide.md) <a id="facebook"></a>
Facebook has blocked all non-approved applications from posting to a group programmatically. Although Tautulli shouldn't be against their terms, they are refusing to approve any app that can do this.
There only currently known workaround is that Zapier also allows posting to Facebook, see [their agent guide](https://github.com/Tautulli/Tautulli/tree/e715b0dc5c802c5223a5b103b25d2f3517ffab9b/docs/Notification-Agents-Guide/README.md#zapier) for how to set this up. See [here](https://i.imgur.com/rcWtoZk.png) for an example Facebook configuration within Zapier.
Old, non-working instructions \[This script\]\(https://gist.github.com/spuniun/56624e1464c621c91e52f88e03321582\) by \[@spuniun\]\(https://github.com/spuniun\) could be used to post directly, however, Facebook has started banning accounts using it so it has been removed from the recommended methods. See the \[Custom Scripts\]\(Custom-Scripts\) page for help setting it up. \*\*Note:\*\* Facebook has \[redone their app approval process\]\(https://developers.facebook.com/blog/post/2018/05/01/enhanced-developer-app-review-and-graph-api-3.0-now-live/\), as such \*\*all\*\* apps \_must\_ go through the approval process fully before they will work again. To work around this you can send notifications via email to the group's secret email address from an account that is in the group. \*\*Note:\*\* As of March 2018, all new Facebook apps require HTTPS for authorization. If Tautulli is not running with HTTPS, the easiest method would be to check "Enable HTTPS" under the Web Interface tab \(show advanced\). This can be disabled after authorizing with Facebook. 1. Go to \[Facebook Developers\]\(https://developers.facebook.com/apps\) and click \`Add a New App\`. 1. Click Add Product on the left, then click \`Set Up\` for Facebook Login. 1. Skip the Quickstart and go to Facebook Login &gt; Settings on the left, and fill in the \*\*Valid OAuth redirect URIs\*\* with the one provided by Tautulli. 1. Go to Settings &gt; Basic on the left, and fill in a \*\*Privacy Policy URL\*\*. 1. On the same page, get your \*\*App ID\*\* and \*\*App Secret\*\* and fill in the respective Tautulli settings. 1. Go to App Review on the left, and toggle your app to toggle "Make Public" to \`Yes\`. 1. Click the \`Request Authorization\` button in Tautulli to allow it to access your Facebook account. Make sure the app visibility is set to \`Public\` or \`Friends\` \(\`Only Me\` will not work\). 1. Copy the \*\*Access Token\*\* and fill in the Tautulli setting if it is not filled in automatically. 1. Get your \*\*Group ID\*\* from the URL of your group page \(e.g. \`https://www.facebook.com/groups/\`\) and fill in the Tautulli setting. If you have customized the URL and no longer have easy access to the Group ID, see \[this answer\]\(https://stackoverflow.com/questions/8957340/how-do-i-find-my-facebook-group-id\) for how to obtain it. \_Note:\_ You should \_only\_ put the ID in the setting for Tautulli, not the full URL.
## [GroupMe](notification-agents-guide.md) <a id="groupme"></a>
1. Go to [GroupMe Developers](https://dev.groupme.com) and click **Access Token** at the top. Copy the token and fill in the Tautulli setting.
2. Go to the **Bots** tab at the top and click **Create Bot**.
3. Select the group chat where you want the notifications to be sent, give your bot a **Name** and **Avatar**, and click `Submit`. All other fields can be left at their default values.
4. Copy the **Bot ID** and fill in the Tautulli setting.
## [Growl](notification-agents-guide.md) <a id="growl"></a>
1. Open Growl and go to the General tab to make sure Growl is turned `On` and running.
2. Optional: Go to the Security tab to set up a **Password**. Check "Allow network notifications" if Growl is running on a separate machine than Tautulli.
3. Fill in the **Host** for the machine running Growl \(e.g. `localhost` or `192.168.0.100`\) in the Tautulli settings.
4. Fill in the **Password**, if required, in the Tautulli settings.
## [Hipchat](notification-agents-guide.md) <a id="hipchat"></a>
1. Go to [Hipchat Integrations](https://www.hipchat.com/addons/), select the room where you want the notifications to be sent, and click **Build your own integration**.
2. Give your integration a **Name** and click `Create`.
3. Copy the **Integration URL** and fill in the Tautulli setting.
## [IFTTT](notification-agents-guide.md) <a id="ifttt"></a>
1. Go to IFTTT and set up your [Webhooks](https://ifttt.com/maker_webhooks) service.
2. Click on **Documentation** to get your **Webhook Key** and fill in the Tautulli setting.
3. Create a [New Applet](https://ifttt.com/create), with "this" as "Webhooks", and the trigger "Receive a web request".
4. Fill in the **Event Name** with the one that matches the Tautulli setting.
* **Tip:** You can create different IFTTT events \(e.g. `tautulli_play`, `tautulli_stop`, `tautulli_created`, etc.\) by adding `{action}` to the Event Name in Tautulli \(e.g. `tautulli_{action}`\).
5. Select "that" as whichever service you want.
6. Fill in the settings of your service by adding the ingredients `Value1`, `Value2`, and `Value3`.
* `Value1` will be the subject line in your notification text settings.
* `Value2` will be the body text in your notification text settings.
* \(Optional\) `Value3` can be anything you select \(e.g. Poster URL\).
## [Join](notification-agents-guide.md) <a id="join"></a>
1. Go to [Join App](https://joinjoaomgcd.appspot.com), and click on `Join API`, then `Show`.
2. Copy the **API Key** and fill in the Tautulli setting.
## [Kodi](notification-agents-guide.md) <a id="xbmc"></a>
1. From within Kodi, go to Settings &gt; Service settings &gt; Control, and make sure "Allow remote control via HTTP" is checked.
2. Optional: Set the **Port**, **Username**, and **Password** for the Kodi Webserver. The default port is `8080`.
3. Enter in the **Host Address** for the machine running Kodi \(e.g. `http://localhost:8080`\) in the Tautulli settings.
4. Fill in the **Username** and **Password**, if required, in the Tautulli settings.
## [macOS Notification Center](notification-agents-guide.md) <a id="osx"></a>
**Note:** macOS Notification Center notifications will only work on the machine where Tautulli is installed.
1. Fill in the path to your Tautulli application. The default is `/Applications/Tautulli`.
2. Click the `Register App` button to register Tautulli with the Notification Center.
## [MQTT](notification-agents-guide.md) <a id="mqtt"></a>
1. Fill in the settings from your MQTT broker.
## [Notify My Android](notification-agents-guide.md) <a id="nma"></a>
1. Go to [Notify My Android](https://notifymyandroid.appspot.com/account.jsp) and click `Generate New Key`.
2. Copy the **API Key** and fill in the Tautulli setting.
## [Plex Home Theater](notification-agents-guide.md) <a id="plex"></a>
**Note:** Plex Home Theater notifications only work with [OpenPHT](https://forums.plex.tv/discussion/264209/release-openpht-1-8-0/p1) or [RasPlex](https://forums.plex.tv/discussion/264208/release-rasplex-1-8-0/p1).
1. From within OpenPHT/RasPlex, go to Preferences &gt; System &gt; Services, and make sure "Allow remote control via HTTP" is checked.
2. Enter in the **Host Address** for the machine running OpenPHT or RasPlex with the port `3005` \(e.g. `http://localhost:3005`\).
3. Fill in the **Username** and **Password**, if required, in the Tautulli settings.
## [Plex Android / iOS App](notification-agents-guide.md) <a id="plexmobileapp"></a>
**Note:** Plex Pass is required to send notifications to the Plex mobile apps.
1. Open the Plex Android or iOS app, go to Settings &gt; Notifications and enable the following notifications matching the triggers in the Tautulli notification agent:
1. **New Content Added to Library** - Tautulli trigger: Recently Added
* Note: Make sure to _uncheck_ all libraries for the server connected to Tautulli.
2. **Playback Started** - Tautulli trigger: Playback Start
* Note: Make sure to _uncheck_ the server and all users connected to Tautulli.
3. **New Devices** - Tautulli trigger: User New Device
* Note: Make sure to _uncheck_ the server connected to Tautulli.
2. Send a Test Notification from Tautulli and you should receive one test notification _for each notification_ you have enabled in the Plex App.
**Note:** The user\(s\) receiving the notifications must have notifications enabled for the matching Tautulli triggers in their Plex mobile app.
**Note:** The user\(s\) must _uncheck_ all the servers, libraries, and users connected to Tautulli in the Plex mobile app settings otherwise they may receive duplicate notifications from Plex and Tautulli. Use the [custom notification agent conditions](https://github.com/Tautulli/Tautulli/tree/e715b0dc5c802c5223a5b103b25d2f3517ffab9b/docs/Custom-Notification-Conditions/README.md) in Tautulli to filter the notifications instead.
**Note:** Push notifications do not need to be enabled in your Plex server Settings &gt; General page. However, you may leave it enabled to receive the other notifications types from Plex \(new server shared with you, new item on deck, database corruption detected, database backed up, etc.\).
## [Prowl](notification-agents-guide.md) <a id="prowl"></a>
1. Go to [Prowl](https://www.prowlapp.com/api_settings.php), and generate a new API key by clicking `Generate Key`.
2. Copy the **API Key** and fill in the Tautulli Setting.
## [Pushbullet](notification-agents-guide.md) <a id="pushbullet"></a>
1. Go to [Pushbullet Account Settings](https://www.pushbullet.com/#settings/account), and click `Create Access Token`.
2. Copy the **Access Token** and fill in the Tautulli Setting.
## [Pushover](notification-agents-guide.md) <a id="pushover"></a>
1. Go to Pushover, and [Create a New Application](https://pushover.net/apps/build).
2. Give your application a **Name** and **Icon**, and click `Create Application`.
3. Copy the **API Token** and fill in the Tautulli Setting.
4. Go back to the [Pushover homepage](https://pushover.net).
* If you want to send notifications to yourself, copy your **User Key** and fill in the Tautulli setting.
* If you want to send notifications to a group, go to [Create a New Group](https://pushover.net/groups/build). Copy the **Group Key** and fill in the Tautulli setting.
## [Script](notification-agents-guide.md) <a id="scripts"></a>
* Please see the \[\[Custom Scripts Wiki Page\|Custom Scripts\]\].
## [Slack](notification-agents-guide.md) <a id="slack"></a>
1. Go to Slack, and create a new [Incoming Webhook](https://my.slack.com/services/new/incoming-webhook).
2. Select the slack channel where you want the notifications to be sent, and click \`Add Incoming Webhooks integration.
3. Copy your **Webhook URL** and fill in the Tautulli setting.
4. Scroll down to Integration Settings, and give your integration a **Name** and **Icon**. This can be changed in the Tautulli settings instead if you wish.
## [Tautulli Remote Android App](notification-agents-guide.md) <a id="androidapp"></a>
* Please see the [Tautulli Remote Wiki](https://github.com/Tautulli/Tautulli-Remote/wiki/Registering-a-Tautulli-server) on how to register your [Tautulli Remote Android App](https://play.google.com/store/apps/details?id=com.tautulli.tautulli_remote).
## [Telegram](notification-agents-guide.md) <a id="telegram"></a>
1. Message [`@BotFather`](https://telegram.me/BotFather) on Telegram with the command `/newbot` to create a new bot.
2. Follow the instructions to give your bot a display name and a bot username.
3. Copy the **Bot Token** and fill in the Tautulli setting.
**Sending Messages to Yourself**
1. Create a new chat with your bot.
2. Message [`@IDBot`](https://telegram.me/myidbot) on Telegram with the command `/getid` to get your **Chat ID**.
3. Copy the **Chat ID** and fill in the Tautulli setting.
**Sending Messages to a Group**
1. Create a new group chat with your bot and [`@IDBot`](https://telegram.me/myidbot).
2. Message [`@IDBot`](https://telegram.me/myidbot) in the group with the command `/getgroupid` to get your **Group ID**.
3. Copy the **Group ID** and fill in the Tautulli setting. Don't forget the hyphen \(`-`\) in the Group ID.
**Sending Messages to a Channel**
1. Create a new Public Channel in Telegram.
2. Go to Manage Channel and add your bot to the Administrators.
3. Add a "Link" to your channel. This is your channel username \(e.g. `t.me/<CHANNEL_USERNAME>`\).
4. Copy the **Channel Username** and fill in the Tautulli setting. Don't forget the at sign \(`@<CHANNEL_USERNAME>`\) in the Channel Username.
## [Twitter](notification-agents-guide.md) <a id="twitter"></a>
1. Go to [Twitter Apps](https://apps.twitter.com) and click `Create New App`.
2. Give your app a **Name**, **Description**, and **Website**. A valid website is not required.
3. Go to the "Keys and Access Tokens" tab to get your **Consumer Key** and **Consumer Secret**, and fill in the respective Tautulli settings.
4. Click on `Create my access token` to get your **Access Token** and **Access Token Secret**, and fill in the respective Tautulli settings.
## [Webhook](notification-agents-guide.md) <a id="webhook"></a>
1. Find the **Webhook URL** for the service you are going to be using and fill in the Tautulli setting. Some examples:
* Discord: [Intro to Webhooks](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
* Slack: [Incoming Webhooks](https://api.slack.com/incoming-webhooks)
2. Pick the appropriate HTTP request method for your **Webhook Method**. Generally, you want to select `POST` here.
3. Customize the raw **JSON Data** sent to the webhook on the **Data** tab.
## [Zapier](notification-agents-guide.md) <a id="zapier"></a>
1. Go to Zapier and [`Make a Zap`](https://zapier.com/app/editor).
2. For "When this happens...", Choose App as "Webhooks by Zapier", and Choose Trigger as "Catch Hook", then click `Continue`.
3. Copy the **Custom Webhook URL** and fill in the Tautulli setting, then click `Continue` in Zapier.
4. Click `Test & Review` in Zapier, then click the `Send Test Data` button in Tautulli. A new hook will show up in Zapier with test data from Tautulli. Once everything is okay, click `Done Editing`.
5. For "Do this...", Choose App as whichever service you want, and follow the instructions to connect the service.
6. Set Up Template using the values `Body`, `Subject`, `Action`, `Provider Name`, `Provider Link`, `Plex URL`, and `Poster URL`. These values will all be filled in by Tatutulli.
7. Make sure your Zap is turned `on` in the top right.