drkno/plexsso

PlexSSO 镜像文档

概述

PlexSSO是一个基于nginx auth_request的单点登录服务，使用Plex作为上游授权提供者。它设计用于前置多种服务，统一其认证机制，替代各服务自身的登录系统。该服务兼容多种媒体相关应用，且独立于特定前端或使用模式，不与任何界面绑定。

核心功能和特性

• 基于Plex认证：利用Plex账户和服务器权限进行用户验证，无需单独管理用户体系
• 多服务支持：兼容多种媒体工具，包括但不限于：
  • Bazarr、Deluge、Jackett、Lidarr、NzbHydra（v1和v2）、NzbGet
  • Ombi、Radarr、Readarr、Sabnzbd、Sonarr、Transcoderr、Transmission
• 独立架构：不依赖特定前端界面，可灵活集成到现有系统
• 细粒度访问控制：支持按服务、路径和用户权限级别定义访问规则
• 灵活配置：通过配置文件和CLI参数定制认证行为，支持Cookie域设置、访问拒绝消息自定义等

使用场景

适用于需要统一管理多个媒体服务认证的环境，尤其适合：

• 家庭媒体服务器，集中管理Bazarr、Sonarr等工具的访问权限
• 使用Plex作为用户管理中心的场景，利用Plex的用户层级控制服务访问
• 需要简化多服务登录流程，避免为每个应用单独创建账户的场景

安装与使用方法

前提条件

• 安装docker和nginx（推荐通过Docker容器部署nginx）

启动PlexSSO容器

使用以下命令启动PlexSSO服务（替换示例中的服务器标识符）：

bash
docker run -p 4200:4200/tcp --name plexsso -ti drkno/plexsso:latest -s 0123456789abcdef0123456789abcdef01234567

详细参数说明参见CLI参数部分

配置nginx

需配置nginx以同时代理PlexSSO和上游服务。每个上游服务的nginx配置中需指定auth_request，指向PlexSSO容器的4200端口。示例配置可参考项目仓库的/nginx目录。

配置说明

配置文件

PlexSSO默认通过config.json文件进行配置，若未找到配置文件，启动时会生成默认配置。配置文件路径可通过--config参数指定（默认在当前工作目录或Docker中的/config/）。

配置文件示例

json
{
  "serverIdentifier": "0123456789abcdef0123456789abcdef01234567",
  "plexPreferencesFile": null,
  "cookieDomain": ".example.com",
  "defaultAccessDeniedMessage": "Access Denied",
  "accessControls": {
    "example-service": [
      {
        "path": "/",
        "blockMessage": "Access Denied.<br />Please use <a href='https://ombi.example.com'>Ombi</a> instead.",
        "minimumAccessTier": "NormalUser",
        "controlType": "Block",
        "exempt": [
          "some-exempt-user"
        ]
      }
    ]
  },
  "ombiPublicHostname": "https://ombi.example.com",
  "tautulliPublicHostname": "https://plexpy.example.com"
}

配置文件属性说明

访问控制规则属性说明

CLI参数

所有CLI参数均可在配置文件中设置，命令行参数优先级高于配置文件。