<%inherit file="base.html"/> <%! import os import sys import plexpy from plexpy import common, notifiers from plexpy.helpers import anon_url available_notification_agents = sorted(notifiers.available_notification_agents(), key=lambda k: k['label']) %> <%def name="headIncludes()"> <%def name="headerIncludes()"> <%def name="body()">
Settings
% if config['check_github']:
% endif
% if common.VERSION_NUMBER:

### Version ${common.VERSION_NUMBER} Changelog

% endif

### PlexPy Configuration

Loading configuration table...

### PlexPy Scheduled Tasks

Loading scheduler table...

### Updates

Enable Updates

Check for PlexPy updates periodically.

Update Automatically

Update PlexPy automatically if an update is available when checking for updates.

GitHub API Token

Optional: Use your own GitHub API token when checking for updates.

### Display Settings

Date Format

Set your preferred date format. Click here to see the parameter list.

Time Format

Set your preferred time format. Click here to see the parameter list.

Group Table and Watch Statistics History

Group successive play history by the same user as a single entry in the tables and watch statistics.

Current Activity in History Tables

Include current activity in the history tables. Statistics will not be counted until the stream has ended.

Watched Percent

Set the percentage for a media item to be considered as watched. Minimum 50, Maximum 95.

### Backup

Backup Interval

The interval (in hours) PlexPy will backup the database and configuration file. Minimum 1, maximum 24, default 6.

Backup Days

The number of days to keep scheduled backups. Minimum 1, default 3.
Note: Manual backups are not removed automatically.

### Directories

Backup Directory
Cache Directory
Log Directory

### Sections

Select the sections to show on the homepage. Drag the items below to reorder your homepage content.

- Current Activity
- Watch Statistics
- Library Statistics
- Recently Added

### Watch Statistics

Select the cards to show in the watch statistics on the home page. Drag the items below to reorder your homepage content.

- Most Watched Movie
- Most Popular Movie
- Most Watched TV
- Most Popular TV
- Most Listened to Artist
- Most Popular Artist
- Last Watched
- Most Active User
- Most Active Platform
- Most Concurrent Streams

Time Frame

Specify the number of days for the watch statistics on the home page. Default is 30 days.

Top Lists

Specify the number of items to show in the top lists for the watch statistics on the home page. Maximum 10 items, default 5 items, 0 to disable.

Use Play Duration

Use play duration instead of play count to generate statistics.

### Library Statistics

Select the cards to show in the library statistics on the home page. Drag the items below to reorder your homepage content.

### Web Interface

Web interface changes require a restart.

HTTP Host

e.g. localhost or an IP, such as 0.0.0.0

HTTP Port

Port to bind web server to. Note that ports below 1024 may require root.

HTTP Root

The base URL of the web server. Used for reverse proxies.

Launch Browser on Startup

Launch browser pointed to PlexPy on startup.

Enable HTTPS

Enable HTTPS for web server for encrypted communication.

Create Self-signed Certificate

Check to have PlexPy create a self-signed SSL certificate. Uncheck if you want to use your own certificate.

HTTPS Domains

The domain names used to access PlexPy, separated by commas (,).

HTTPS IPs

The IP addresses used to access PlexPy, separated by commas (,).

HTTPS Cert

The location of the SSL certificate.

HTTPS Key

The location of the SSL key.

### Authentication

Authentication changes require a restart.

HTTP Username

Username for web server authentication. Leave empty to disable.

HTTP Password

Password for web server authentication. Leave empty to disable.

Hash Password in the Config File

Store a hashed password in the config file.
Warning: Your password cannot be recovered if forgotten!

Use Basic Authentication

Use basic HTTP authentication instead of the HTML login form.

### Guest Access

Allow Guest Access to PlexPy

Allow shared users to login to PlexPy using their Plex.tv account. Individual user access needs to be enabled from Users > Edit Mode.

### API

Enable API

Allow remote applications to interface with PlexPy.

API key

Current API key: ${config['api_key']}

### Plex Media Server Version ${config['pms_version']}

If you're using websocket monitoring, any server changes require a restart of PlexPy.

Monitor Plex Updates

Enable to have PlexPy check if updates are available for the Plex Media Server.

Update Channel
Release
Monitor Plex Remote Access

Enable to have PlexPy check if remote access to the Plex Media Server goes down.

Plex IP or Hostname

IP Address or hostname for Plex Media Server.

Plex Port

Port that Plex Media Server is listening on.

Remote Server

Check this if your Plex Server is not on the same local network as PlexPy.

Use SSL

If you have secure connections enabled on your Plex Server, communicate with it securely.

### Plex Logs

Logs Folder

Set the complete folder path where your Plex Server logs are, shortcuts are not recognized. Click here for help.

### Plex.tv Authentication

PMS Token

Token for Plex.tv authentication.

### Friends List

Users List Refresh Interval

The interval (in hours) PlexPy will request an updated friends list from Plex.tv. Minimum 1, maximum 24, default 12.

Refresh Users List on Startup

Refresh the users list when PlexPy starts.

### Libraries List

Libraries List Refresh Interval

The interval (in hours) PlexPy will request an updated libraries list from your Plex Media Server. Minimum 1, maximum 24, default 12.

Refresh Libraries List on Startup

Refresh the libraries list when PlexPy starts.

% if plexpy.INSTALL_TYPE == 'git':

### Git Settings

Git Remote / Branch

The git tracking remote and branch (default "origin/master"). Select to switch the git branch (requires restart).

Git Path

The path to your git environment variable. Leave blank for default.

% endif

### Extra Settings

Use Video Preview Thumbnails (BIF)

If you have media indexing enabled on your server, use these on the activity pane.

Calculate Total File Sizes [experimental]

Enable if you want PlexPy to calculate the total file size for TV Shows/Seasons and Artists/Albums on the media info tables.

Mask Sensitive Information in Logs

Enable to mask passwords, access tokens, and public IP addresses with asterisks (*) in the logs.
Note: Only logs from the time this setting is enabled will be masked. Do not post your logs publically without masking sensitive information!

Cache Plex Images

Enable to cache images from Plex to reduce API calls and improve loading times.
Note: Video preview thumbnails (BIF) are not cached.

Anonymous Redirect

Backlink protection via anonymizer service, must end in "?".

Flush Temporary Sessions

Attempt to fix history logging by flushing out all of the temporary sessions in the database.
Warning: This will reset all currently active sessions. For emergency use only when history logging is stuck!

### Database Import Tool

Click a button below to import an exisiting database from another app.

### Monitoring Settings

Monitoring Interval

The interval (in seconds) PlexPy will ping your Plex Server. Minimum 30 seconds, recommended 60 seconds.
Note: Only used for checking Plex remote access.

### History Logging

Keep records of all movie, TV show, or music items played from your Plex Media Server.

Enable Movie Logging
Enable TV Show Logging
Enable Music Logging
Ignore Interval

The interval (in seconds) an item must be in a playing state before logging it. 0 to disable.

### Buffer Warnings

Note: Buffer warnings only work on certain Plex clients. Android and Plex Web do not report buffer events accurately or at all.

Buffer Threshold

How many buffer events should we wait before triggering the first warning. Buffer events increment on each monitor ping if play state is buffering. 0 to disable buffer warnings.

Buffer Wait

The value (in seconds) PlexPy should wait before triggering the next buffer warning. 0 to always trigger.

### Global Notification Settings

Enable Movie Notifications
Enable TV Show Notifications
Enable Music Notifications
Enable Recently Added Notifications
Enable Posters in Notifications

Enable to upload Plex posters to Imgur for notifications. Disable if posters are not being used to save bandwidth.

Imgur Client ID

Enter your Imgur API client ID in order to upload posters. You can register a new application here.

### Current Activity Notifications

Allow Consecutive Notifications

Enable to allow sending of consecutive notifications (i.e. both watched & stopped notifications).

User Concurrent Streams Notifications by IP Address

Enable to only send a notification of concurrent streams by a single user from different IP addresses.

User Concurrent Stream Threshold

The number of concurrent streams by a single user for PlexPy to trigger a notification. Minimum 2.

### Recently Added Notifications

Group Notifications by Season or Album

Enable to only send one season or album notification when multiple episodes or tracks are added. Movies, single episodes, and single tracks are unaffected.
Note: An episode/track range can be shown (e.g. 01-12), but all other episode/track metadata will be unavailable.

Group Notifications by TV Show or Artist

Enable to only send one TV show or artist notification when multiple seasons or albums are added. Movies, single episodes, and single tracks are unaffected.
Note: A season range can be shown (e.g. 1-3), but all other season/episode/album/track metadata will be unavailable.

Send a Notification for New Versions

Enable to send another recently added notification when adding a new version of existing media.
Note: If multiple versions are available, PlexPy will assume the higher quality one is newer.

### Notification Agents

Add a new notification agent, or configure an existing notification agent by clicking the settings icon on the right.

Loading notification agents...

### PlexPy Remote App

Get the App

Get the PlexPy Remote app on Google PlayTM to access PlexPy from your Android device!

Link the App

Link the app to your server by scanning a QR code.

The API must be enabled under Access Control to use the app.

#### Date & Time Format Options

Year
YYYY | Numeric, four digits | E.g. 1999, 2003
YY | Numeric, two digits | E.g. 99, 03

Month
MMMM | Textual, full | January-December
MMM | Textual, three letters | Jan-Dec
MM | Numeric, with leading zeros | 01-12
M | Numeric, without leading zeros | 1-12

Day of the Year
DDDD | Numeric, with leading zeros | 001-365
DDD | Numeric, without leading zeros | 1-365

Day of the Month
DD | Numeric, with leading zeros | 01-31
D | Numeric, without leading zeros | 1-31
Do | Numeric, with suffix | E.g. 1st, 2nd ... 31st.

Day of the Week
dddd | Textual, full | Sunday-Saturday
ddd | Textual, three letters | Sun-Sat
d | Numeric | 0-6

Hour
HH | 24-hour, with leading zeros | 00-23
H | 24-hour, without leading zeros | 0-23
hh | 12-hour, with leading zeros | 01-12
h | 12-hour, without leading zeros | 1-12

Minute
mm | Numeric, with leading zeros | 00-59
m | Numeric, without leading zeros | 0-59

Second
ss | Numeric, with leading zeros | 00-59
s | Numeric, without leading zeros | 0-59

AM / PM
A | AM/PM uppercase | AM, PM
a | am/pm lowercase | am, pm

Timezone
ZZ | UTC offset | E.g. +0100, -0700
Z | UTC offset | E.g. +01:00, -07:00

Timestamp
X | Unix timestamp | E.g. 1456887825

#### Fetch Plex.tv Token

This will attempt to fetch a new Plex.tv token for you. PlexPy does not store your username and password. Note: This will not work on Internet Explorer 9 or lower.

Plex.tv Username

Username for Plex.tv authentication.

Plex.tv Password

Password for Plex.tv authentication.

#### Add a Notification Agent

% for agent in available_notification_agents:
- ${agent['label']}
% endfor

#### Notification Parameters

If the value for a selected parameter cannot be provided, it will display as blank.

Global
{plexpy_version} | The current version of PlexPy.
{plexpy_branch} | The current git branch of PlexPy.
{plexpy_commit} | The current git commit hash of PlexPy.
{server_name} | The name of your Plex Server.
{server_uptime} | The uptime (in days, hours, mins, secs) of your Plex Server.
{server_version} | The current version of your Plex Server.
{action} | The action that triggered the notification.
{datestamp} | The date (in date format) the notification was triggered.
{timestamp} | The time (in time format) the notification was triggered.

Stream Details
{streams} | The number of concurrent streams.
{user_streams} | The number of concurrent streams by the person streaming.
{user} | The friendly name of the person streaming.
{username} | The username of the person streaming.
{platform} | The type of client being used for playback.
{player} | The name of the device being used for playback.
{ip_address} | The IP address of the device being used for playback. (PMS 0.9.14 and above)
{stream_duration} | The stream duration (in minutes) for the item.
{stream_time} | The stream duration (in time format) for the item.
{remaining_duration} | The remaining duration (in minutes) for the item.
{remaining_time} | The remaining duration (in time format) for the item.
{progress_duration} | The last reported offset (in minutes) for the item.
{progress_time} | The last reported offset (in time format) for the item.
{progress_percent} | The last reported progress percent for the item.
{transcode_decision} | The stream transcode decisions for the media item.
{video_decision} | The video transcode decisions for the media item.
{audio_decision} | The audio transcode decisions for the media item.
{transcode_container} | The media container of the transcoded media.
{transcode_video_codec} | The video codec of the transcoded media.
{transcode_video_width} | The video width of the transcoded media.
{transcode_video_height} | The video height of the transcoded media.
{transcode_audio_codec} | The audio codec of the transcoded media.
{transcode_audio_channels} | The audio channels of the transcoded media.
{session_key} | The unique identifier for the stream session.
{transcode_key} | The unique identifier for the transcode session.
{user_id} | The unique identifier for the user.
{machine_id} | The unique identifier for the player.

Metadata Details
{media_type} | The type of media. (movie, episode, track)
{container} | The media container of the original media.
{video_codec} | The video codec of the original media.
{video_bitrate} | The video bitrate of the original media.
{video_width} | The video width of the original media.
{video_height} | The video height of the original media.
{video_resolution} | The video resolution of the original media.
{video_framerate} | The video framerate of the original media.
{aspect_ratio} | The aspect ratio of the original media.
{audio_codec} | The audio codec of the original media.
{audio_channels} | The audio channels of the original media.
{title} | The full title of the item.
{library_name} | The library name of the item.
{show_name} | The title of the TV series.
{episode_name} | The title of the episode.
{artist_name} | The name of the artist.
{album_name} | The title of the album.
{track_name} | The title of the track.
{season_num} | The season number. (e.g. 1, or 1-3)
{season_num00} | The two digit season number. (e.g. 01, or 01-03)
{episode_num} | The episode number. (e.g. 6, or 6-10)
{episode_num00} | The two digit episode number. (e.g. 06, or 06-10)
{track_num} | The track number. (e.g. 4, or 4-10)
{track_num00} | The two digit track number. (e.g. 04, or 04-10)
{year} | The release year for the item.
{release_date} | The release date (in date format) for the item.
{air_date} | The air date (in date format) for the item.
{added_date} | The date (in date format) the item was added to Plex.
{updated_date} | The date (in date format) the item was updated on Plex.
{last_viewed_date} | The date (in date format) the item was last viewed on Plex.
{studio} | The studio for the item.
{content_rating} | The content rating for the item. (e.g. TV-MA, TV-PG, etc.)
{directors} | A list of directors for the item.
{writers} | A list of writers for the item.
{actors} | A list of actors for the item.
{genres} | A list of genres for the item.
{summary} | A short plot summary for the item.
{tagline} | A tagline for the media item.
{rating} | The rating (out of 10) for the item.
{duration} | The duration (in minutes) for the item.
{poster_url} | A URL for the movie, TV show, or album poster.
{plex_url} | The Plex URL to your server for the item.
{imdb_id} | The IMDB ID for the movie. (e.g. tt2488496) (PMS agent must be Plex Movie)
{imdb_url} | The IMDB URL for the movie. (PMS agent must be Plex Movie)
{thetvdb_id} | The TVDB ID for the TV show. (e.g. 121361) (PMS agent must be TheTVDB)
{thetvdb_url} | The TVDB URL for the TV show. (PMS agent must be TheTVDB)
{themoviedb_id} | The TMDb ID for the movie or TV show. (e.g. 15260) (PMS agent must be The Movie Database)
{themoviedb_url} | The TMDb URL for the movie or TV show. (PMS agent must be The Movie Database)
{lastfm_url} | The Last.fm URL for the album. (PMS agent must be Last.fm)
{trakt_url} | The trakt.tv URL for the movie or TV show.
{file} | The file path to the item.
{file_size} | The file size of the item.
{section_id} | The unique identifier for the library.
{rating_key} | The unique identifier for the movie, episode, or track.
{parent_rating_key} | The unique identifier for the season or album.
{grandparent_rating_key} | The unique identifier for the TV show or artist.

Plex Update Available
{update_version} | The available update version for your Plex Server.
{update_url} | The download URL for the available update.
{update_release_date} | The release date of the available update.
{update_channel} | The update channel. (Public or Plex Pass)
{update_platform} | The platform of your Plex Server.
{update_distro} | The distro of your Plex Server.
{update_distro_build} | The distro build of your Plex Server.
{update_requirements} | The requirements for the available update.
{update_extra_info} | Any extra info for the available update.
{update_changelog_added} | The added changelog for the available update.
{update_changelog_fixed} | The fixed changelog for the available update.

PlexPy Update Available
{plexpy_update_version} | The available update version for PlexPy.
{plexpy_update_tar} | The tar download URL for the available update.
{plexpy_update_zip} | The zip download URL for the available update.
{plexpy_update_commit} | The commit hash for the available update.
{plexpy_update_behind} | The number of commits behind for the available update.
{plexpy_update_changelog} | The changelog for the available update.

#### Notification Exclusion Tags

#### Movie Tag

All text inside <movie></movie> tags will only be sent when the media item is a movie.

Example:

    {title} <movie>({year})</movie> was recently added to Plex

#### Show / Season / Episode Tags

All text inside <show></show>/<season></season>/<episode></episode> tags will only be sent when the media item is a show/season/episode.

Example:

    {show_name}<season> - Season {season_num}</season><episode> - S{season_num}E{episode_num} - {episode_name}</episode> was recently added to Plex.

#### Artist / Album / Track Tag

All text inside <artist></artist>/<album></album>/<track></track> tags will only be sent when the media item is an artist/album/track.

Example:

    {artist_name}<album> - {album_name}</album><track> - {album_name} - {track_name}</track> was recently added to Plex.

#### Changelog

#### Restart

You have changed settings that require PlexPy to restart.
Click the restart button below to restart now.

#### Link PlexPy Remote App

Instructions

Scan the QR code below with the PlexPy Remote app to automatically link it with the server.

QR Code

Encoded String

Note: This is a private IP address. PlexPy will not be reachable outside of your home network. Access PlexPy externally to generate the QR code for remote access.

<%def name="javascriptIncludes()">