Package Health Score

53 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.1.4	\|	11/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.3	\|	10/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.5	\|	08/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.9.1	\|	08/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.8.11	\|	02/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (39)

GitHub Stars: 8
Forks: 5
Contributors: 10

Direct Usage Popularity

The npm package iobroker.plex receives a total of 39 downloads a week. As such, we scored iobroker.plex popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package iobroker.plex, we found that it has been starred 8 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 10
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like iobroker.plex is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 4
Open PR: 15
Last Release: 1 year ago
Last Commit: 1 month ago

Further analysis of the maintenance status of iobroker.plex based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for iobroker.plex is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 16

Age: 6 years
Dependencies: 10 Direct
Versions: 40
Install Size: 2.68 MB
Dist-tags: 2
# of Files: 49
Maintainers: 30
TS Typings: No

iobroker.plex has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Logo

ioBroker.plex

Integration of the Plex Media Server in ioBroker (with or without Plex Pass). Furthermore, Tautulli integration.

Number of Installations Stable Version

Table of contents

1. Features

Receive detailed media information about the current played media item (such as video bitrate, codec, subtitle information, audio; see Advanced setup for a full list)
Receive events from Plex (via Plex Webhook and Plex Notifications using Plex Pass or via Tautulli, see setup!)
Playback control for players
Retrieve servers
Retrieve libraries
Retrieve all items within a library
Retrieve users (only with Tautulli)
Retrieve statistics (only with Tautulli)
Retrieve playlists
Retrieve settings
Retrieve all data from controllable clients
Web Interface that shows the recent events from Plex:

2. Setup instructions

2.1. Basic Setup

For the basic setup it is required to provide the IP address (and port) of your Plex installation. Furthermore, you have to retrieve a dedicated token for the adapter to retrieve data from Plex.

Once this is given, ioBroker.plex will retrieve all the basic data (incl. Servers, Libraries). See Channels & States for the full list of basic data.

2.2. Advanced Setup (Plex Pass or Tautulli)

2.2.1. Plex Pass

Webhook

If you are a Plex Pass user, you may setup a webhook in the Plex Settings to retrieve the current event / action from your Plex Media Server (play, pause, resume, stop, viewed and rated).

Navigate to your Plex Media Server and go to Settings and Webhook. Created a new webhook by clicking Add Webhook and enter your ioBroker IP adress with the custom port specified in the ioBroker.plex settings and trailing /plex path, e.g. https://192.168.178.29:41891/plex:

Plex Webhook

Events

For information regarding the Plex Notifications, please see the official documentation. To turn on Notifications on your Plex Media Server, go to Settings > Server > General and then enable the Push Notifications preference.

2.2.2.Tautulli

Tautulli is a 3rd party 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. Check out Tautulli Preview and install it on your preferred system if you are interested.

This adapter connects to the Tautulli API and also receives webhook events from Tautulli.

2.2.2.1. API

Once Tautulli is installed, open the Settings page from Tautulli dashboard and navigate to Web Interface. Scroll down to the API section and make sure Enable API is checked. Copy the API key and enter it in the ioBroker.plex settings. Furthermore, add the Tautulli IP address and port to allow API communication.

2.2.2.2. Webhook

Overview

To setup a webook using Tautulli, following the instrucutions below and make sure you have completed all 4 steps:

Add Notification Agent
Configure Webhook in Notification Agent
Configure Triggers in Notification Agent
Configure Data in Notification Agent
Configure Notification options

Description

Once installed open the settings page from Tautulli dashboard and navigate to Notification Agents as seen below:

Tautulli Settings

Click Add a new notification agent and Webhook.
Enter your ioBroker IP adress with the custom port specified in the ioBroker.plex settings and trailing /tautulli path, e.g. https://192.168.178.29:41891/tautulli:

Furthermore, choose POST for the Webhook Method and enter any description you like in Description.
Next, go to the Triggers tab, select your desired (or simply all) notification agents. An enabled notification agent will trigger an event which will then be sent to ioBroker. Make sure to provide the necessary data for each of the enabled notification agent in the next step!
Now, most importantly, fill in the respective data payload in the Data tab according to the Notification configuration found here. Copy the notification configuration of the relevant notification agents from the previous step (e.g. Playback Start, Playback Stop, Playback Pause and Playback Resume) in each of the text boxes as shown below for Playback Start:
Finally, check the option Allow Consecutive Notifications to enable to allow sending of consecutive notifications (e.g. both watched & stopped notifications):

3. Channels & States

Having both the basic and advanced setup configured, the following channels will appear (libraries, servers and users are only examples of course). See further below for full list of channels & states.

Channels States Exeample

3.1. With Basis Setup

After sucessful basic setup the channels according to the following table will be created. For a list of all states which will be created, please see dedicated list of states.

Channel / Folder	Description
libraries	Plex Libraries
servers	Plex Servers
settings	Plex Settings

3.2. With Advanced Setup

After sucessful advanced setup the following channels will additionally be created. For a list of all states which will be created, please see dedicated list of states.

Channel / Folder	Description	Remark
_playing	Plex Media being played	with Plex Pass or Tautulli
statistics	Plex Watch Statistics	only with Tautulli
users	Plex Users	only with Tautulli

Credits

This adapter would not have been possible without the great work of @Zefau (https://github.com/Zefau), who create and maintained it until 2021 .

Changelog

1.1.4 (2023-11-06)

(ticaki) move logmessage into debug

1.1.3 (2023-10-05)

(ticaki) fixed: bug in readable offset

1.1.2 (2023-09-16)

(ticaki) prevent Plex from crashing due to incorrect tautulli configuration

1.1.1 (2023-09-16)

(ticaki) Fixed: State common.name english/german
(ticaki) some minor improvements

1.1.0 (2023-09-11)

(ticaki) Added: Lyrics are written as link and text in _playing.device.Metadata.Music.Lyric
(ticaki) Added: Connection to players with refresh of playerdetail
(ticaki) Added: New states with player data.
(ticaki) Added: Refresh of player can be activate by set _Controls.timeline.refreshDetails to true

1.0.5 (2023-08-31)

(ticaki) Fixed: Control did not work with Plexamp.
(ticaki) some minor improvements.

1.0.4 (2023-08-27)

(ticaki) Fixed: #184

1.0.3 (2023-08-25)

(ticaki) Fixed: Don't add empty notifications to history #183
(ticaki) Fixed: prevent the creation of duplicate history entries in most cases

1.0.2 (2023-08-23)

(ticaki) Added: a play/pause switch for mediaplayer
(ticaki) Added: links to artworks (ready to use)
(ticaki) Added: state viewOffsetSeconds refresh every second while playing media(internal counter)

1.0.1 (2023-08-21)

(ticaki) Xmlparser call fixed

1.0.0 (2023-08-20)

(ticaki) fixed: several minor issues have been fixed

1.0.0-alpha.3 (2023-08-16)

(ticaki) fixed: common.type warnings have been fixed and missing state definitions have been added #114 #101 #100
(ticaki) fixed: player controls
(ticaki) fixed: history page has been fixed
(ticaki) fixed: translation error has been fixed #108

0.9.0 (2020-05-23)

(Zefau) added option for webhook IP address in case Plex is running in a Docker environment (see #53)
(Zefau) updated dependencies

0.8.11 (2020-02-26)

(Zefau) fixed error with state retrieval on startup when no states are given
(Zefau) updated dependencies

0.8.10 (2020-02-16)

(Zefau) fixed error with state retrieval on startup when no states are given
(Zfeau) fixed incorrect handling of certificates when using secure connection
(Zefau) updated dependencies

0.8.9 (2019-12-14)

(Zefau) updated dependencies
(Zefau) fixed missing spaces in events (and thus Adapter Web View)
(Zefau) fixed using username instead of email for statistics (see #17)

0.8.8 (2019-12-05)

(Zefau) fixed player controls

0.8.7 (2019-12-02)

(Zefau) fixed error with http / https settings

0.8.6 (2019-12-02)

(Zefau) added further states to Tautulli Notification (see README-tautulli.md)
(Zefau) fixed design issue with select-box in the adapter settings
(Zefau) fixed not showing thumbnails in adapter web view (when not using a secure connection)

0.8.5 (2019-12-01)

(Zefau) fixed missing user / library statistics
(Zefau) fixed using username instead of email for statistics (see #17)

0.8.4 (2019-11-07)

(Zefau) added support for remote player control via cloud / iot adapter
(Zefau) added thumbnail to notifications as well as web interface of adapter
(Zefau) fixed icons within the web interface of adapter

0.8.3 (2019-11-06)

(Zefau) fixed player controls (error when triggering start, stop, etc.)
(Zefau) added additional states to event channel

0.8.1 (2019-11-02)

(Zefau) fixed error Cannot read property 'forEach' of undefined

0.8.0 (2019-10-28)

(Zefau) added support for Plex Notifications including customization in adapter settings
(Zefau) added count of streams (see #14)
(Zefau) reworked cleaning up states when new webhook is received (see #11)

0.7.0 (2019-10-17)

(Zefau) reworked duty cycle (clean up of outdated / old states)
(Zefau) fixed incorrect states (see #15)

0.6.0 (2019-08-19)

(Zefau) replaced password with token authentication

0.5.0 (2019-08-18)

(Zefau) added support for Plex Notifications (see #9)
(Zefau) added support for all Tautulli triggers
(Zefau) added Adapter Web Interface that shows the recent events

0.4.3 (2019-08-11)

(Zefau) Performance improvements (dutyCycleRun and state comparison)
(Zefau) added refresh button (to scan library files) to libraries

0.4.1 / 0.4.2 (2019-08-03)

(Zefau) fixed newly introduced playback control not working for certain players
(Zefau) removed unnecessary dependencies

0.4.0 (2019-08-01)

(Zefau) added playback control for players
(Zefau) added configuration options to only retrieve specific objects from Plex

0.3.2 / 0.3.3 (2019-07-25)

(Zefau) added file, streaming and transcoding information to Tautulli event
(Zefau) fixed bug when no playlists exist
(Zefau) fixed missing EVENTS.json

0.3.1 (2019-07-20)

(Zefau) updated dependencies to fix security vulnerabilities in depending packages

0.3.0 (2019-05-16)

(@Apollon77) updated testing for Node.js v12 (see #6)
(Zefau) added support / discovery in iobroker.discovery (see #62)
(Zefau) added playlists to states
(Zefau) added state description for object tree _playing
(Zefau) updated German translation (instead of generating it from English)

0.2.0 (2019-05-14)

(Zefau) added authentication method (using Plex user and Plex password)
(Zefau) fixed @iobroker/adapter-core dependency

0.1.0 (2019-04-26)

(Zefau) get initial data from Plex API
(Zefau) receive events from Plex Webhook (Plex Pass only)
(Zefau) receive events from Tatulli (if used)

License

The MIT License (MIT)

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.

iobroker.plex dependencies

@iobroker/adapter-core axios body-parser express fast-xml-parser multer plex-api tautulli-api uuid xml2js

FAQs

What is iobroker.plex?

Integration of your Plex Media Server and / or your Tautulli. Visit Snyk Advisor to see a full health score report for iobroker.plex, including popularity, security, maintenance & community analysis.

Is iobroker.plex popular?

The npm package iobroker.plex receives a total of 39 weekly downloads. As such, iobroker.plex popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is iobroker.plex well maintained?

We found indications that iobroker.plex maintenance is sustainable demonstrating some project activity. We saw a total of 10 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is iobroker.plex safe to use?

While scanning the latest version of iobroker.plex, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 7 November-2024, at 03:47 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (39)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

ioBroker.plex

1. Features

2. Setup instructions

2.1. Basic Setup

2.2. Advanced Setup (Plex Pass or Tautulli)

2.2.1. Plex Pass

2.2.2.Tautulli

2.2.2.1. API

2.2.2.2. Webhook

Overview

Description

3. Channels & States

3.1. With Basis Setup

3.2. With Advanced Setup

Credits

Changelog

1.1.4 (2023-11-06)

1.1.3 (2023-10-05)

1.1.2 (2023-09-16)

1.1.1 (2023-09-16)

1.1.0 (2023-09-11)

1.0.5 (2023-08-31)

1.0.4 (2023-08-27)

1.0.3 (2023-08-25)

1.0.2 (2023-08-23)

1.0.1 (2023-08-21)

1.0.0 (2023-08-20)

1.0.0-alpha.3 (2023-08-16)

0.9.0 (2020-05-23)

0.8.11 (2020-02-26)

0.8.10 (2020-02-16)

0.8.9 (2019-12-14)

0.8.8 (2019-12-05)

0.8.7 (2019-12-02)

0.8.6 (2019-12-02)

0.8.5 (2019-12-01)

0.8.4 (2019-11-07)

0.8.3 (2019-11-06)

0.8.1 (2019-11-02)

0.8.0 (2019-10-28)

0.7.0 (2019-10-17)

0.6.0 (2019-08-19)

0.5.0 (2019-08-18)

0.4.3 (2019-08-11)

0.4.1 / 0.4.2 (2019-08-03)

0.4.0 (2019-08-01)

0.3.2 / 0.3.3 (2019-07-25)

0.3.1 (2019-07-20)

0.3.0 (2019-05-16)

0.2.0 (2019-05-14)

0.1.0 (2019-04-26)

License

iobroker.plex dependencies

iobroker.plex development dependencies

FAQs

What is iobroker.plex?

Is iobroker.plex popular?

Is iobroker.plex well maintained?

Is iobroker.plex safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues