login-with-plex v1.1.2

Login With Plex

Allows your app to authenticate users with Plex (similar to OAuth2 authorization_code)

Install

npm install login-with-plex

Usage

Step 1 - Initalize

Using login with plex requires initalizing an instance of the PlexLogin class:

const plexLogin = require('login-with-plex');

const plexLoginInstance = new plexLogin.PlexLogin({
  appName: 'My App',
  clientId: 'UUID',
  forwardUrl: 'https://myapp.com/plex-login-redirect'
});

• appName is a string, the name of your application
• clientId is any string to use as the ID of your application - recommended to generate a UUID
• forwardUrl is the location that plex will forward your user to after they login

Step 2 - Send user to login page

When you want the user to login you will need to redirect them to the plex login page

Example implementation with express:

App.get('/login', async function(req, res) {
  // Generate credentials for user
  const credentials = await plexLoginInstance.generateCredentials();
  
  // Save user credentials to their session 
  req.session.plexCredentials = credentials;

  // Redirect user to plex login page
  res.redirect(plexLoginInstance.getLoginUrl(credentials));
})

Step 3 - Retrieve user's plex information after they login

When the user has finished logging in, you can then get their plex information to check if they should be allowed access to your app

You need to create a route in your app which is the route that plex will forward users to (the forwardUrl provided)

Example implementation with express:

App.get('/plex-login-redirect', async function(req, res) {
  // Load user credentials from session
  const credentials = req.session.plexCredentials;

  // Get user's plex information after they have logged in
  const plexUserInfo = await plexLoginInstance.getUserInfo(credentials);

  // You probably want to validate the plex user against your server

  // Save plex user's information somewhere, or in session
  req.session.plexUser = plexUserInfo;
  delete req.session.plexCredentials;

  // Redirect user back to your app
  res.redirect('/home');
})