Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Add Tautulli documentation #9

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: Add Tautulli documentation #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,13 @@ Sonarr's configuration is required to use it's parameters in rules and to remove
| Hostname or IP| The domain name or local IP of the host your server runs on |
| Port | The port Sonarr runs on |
| Api key | Sonarr API key, should be visible in the Sonarr settings |

## Tautulli

Tautulli's configuration is required to use it's parameters in rules.

| Param | Description |
| ------------- |:-------------:|
| Hostname or IP| The domain name or local IP of the host your server runs on |
| Port | The port Tautulli runs on |
| Api key | Tautulli API key, should be visible in the Tautulli settings |
18 changes: 18 additions & 0 deletions docs/Glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,3 +509,21 @@ The key is used for identification in Yaml rule files.
- Key: Overseerr.isRequested
- Availability: movies, shows, seasons, episodes
- Type: boolean

### Tautulli

#### Viewed by (username)

> List of Plex usernames who have viewed (according to Tautulli) the Plex item. The percentage for the item to be considered as viewed is configured in the Tautulli settings.

- Key: Tautulli.seenBy
- Availability: movies, shows, seasons, episodes
- Type: text[]

#### Users that saw all available episodes

> List of users who have seen (according to Tautulli) all available episodes of the Plex item. The percentage for an episode to be considered as viewed is configured in the Tautulli settings.

- Key: Tautulli.sw_allEpisodesSeenBy
- Availability: shows, seasons
- Type: text[]
1 change: 1 addition & 0 deletions docs/Introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@ Maintainerr supports rules across these apps :
- Overseerr
- Radarr
- Sonarr
- Tautulli
4 changes: 2 additions & 2 deletions docs/blog/posts/Tutorial_S01E01.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The rule system behind Maintainerr is quite complex, and therefore powerful. Ge
<img alt="poster" src="https://docs.maintainerr.info/images/movie_poster.png" width="150" height="250"></img>
</p>

Let's take the above movie as an example. This isn't a real movie, but for the purposes of this tutorial we are going to pretend. This movie has the following attributes across Plex, OverSeerr, and Radar:
Let's take the above movie as an example. This isn't a real movie, but for the purposes of this tutorial we are going to pretend. This movie has the following attributes across Plex, Overseerr, and Radarr:

**Plex** -

| Added | Last Viewed | Times Viewed | Audience Rating |
| -------|-------------|--------------|---------------- |
| 3Nov2023 | 10Jan2024 | 4 | 7.3 |

**OverSeerr** -
**Overseerr** -

| Requested by | Requested Date | Times Requested by Anyone|
| ------------| --------------- | ------------- |
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/posts/Tutorial_S01E02.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ Let's bring back the Movie from episode 1, that we wanted to add into our new co
</p>


This movie has the following attributes across Plex, OverSeerr, and Radar:
This movie has the following attributes across Plex, Overseerr, and Radarr:

**Plex** -

| Added | Last Viewed | Times Viewed | Audience Rating |
| -------|-------------|--------------|---------------- |
| 3Nov2023 | 10Jan2024 | 4 | 7.3 |

**OverSeerr** -
**Overseerr** -

| Requested by | Requested Date | Times Requested by Anyone|
| ------------| --------------- | ------------- |
Expand Down