Giter Site home page Giter Site logo

jellyfinmp's Introduction

JellyfinMP

介绍

Jellyfin服务器的Webhook插件能够推送新的媒体入库的消息, 基于这一点实现了通过定时任务每天上午9:00生成一篇新的微信公众号文章的功能.

工作流简介

  1. 你有一个Jellyfin实例正常运行, 小范围内分享给几个朋友, 大家都想知道服务器上最近上新了什么好看的, 你上新了自己中意的电影电视也想安利给所有的朋友.
  2. 于是你在官方插件仓库安装了Webhook插件, 并设置了JellyfinMP来接收, 每次有新的刮削好的媒体入库都会通知给JellyfinMP.
  3. JellyfinMP收到新的媒体入库的请求, 筛选公众号文章所需的内容, 持久化到数据库.
  4. 每天9点, JellyfinMP开始执行定时任务, 查找昨天新入库的所有媒体记录, 生成一篇草稿, 推送到你的公众号草稿箱里, 并通过Bark通知到你(如果配置了Bark)
  5. JellyfinMP自动将草稿发布为普通文章(如果开启配置), 自动将文章群发给所有的订阅者(如果公众号做了认证, 并且开启了配置).
  6. 默认不开启自动发布, 由公众号管理员检查草稿箱文章, 确认无误手动点击群发.

文章示例

快速开始

准备工作

  1. 拥有完全管理权的Jellyfin服务器, 服务器可暴露在公网, 或者可以让JellyfinMP访问到, 并且拥有TMM刮削元数据的完整工作流.
  2. JellyfinMP需要有公网可访问地址, 端口可以自己设置. (微信Token获取需要IP白名单)
  3. 作为管理者拥有一个微信订阅号, 不一定需要认证.
  4. 部署好的MySql8.0, 并且创建好数据库jellyfinmp: create database jellyfinmp;.
  5. 部署好的Bark服务(可选).

前期设置

  1. 登录Jellyfin, 生成一个API密钥. (详情见下文参数说明)
  2. 登录微信开放平台, 获取AppId和AppSecret. 设置IP白名单, 白名单IP填写运行JellyfinMP的机器. (详情见下文参数说明)
  3. 安装和设置Jellyfin的Webhook插件. 可用这个地址加速插件安装
    1. ServerUrl按照实际填写
    2. 选择Add Generic Destination
    3. Webhook Name 填写 JellyfinMP
    4. Webhook Url 填写 http(s)://你的JellyfinMP部署地址:端口/jellyfinmp/webhook/jellyfin
    5. Notification Type 勾选 Item Added , ItemType 全部勾选, 包括 Send All Properties (ignores template)
    6. Add Request Header处添加一项key=Content-Type, value=application/json

启动

docker run -d \
  --name jellyfin-mp \
  --restart=unless-stopped \
  -p 58089:8089 \
  -e DATABASE_URL=localhost:3306 \
  -e DATABASE_USER=user \
  -e DATABASE_PASS=pass \
  -e BARK_SERVER=bark.changeme.com \
  -e BARK_DEVICE=changeme_bark_device_id \
  -e JELLYFIN_SERVER_URL=https://jellyfin.example.com \
  -e JELLYFIN_ADMIN=changeme_jellyfin_user_id \
  -e JELLYFIN_TOKEN=changeme_jellyfin_token \
  -e MP_APP_ID=changeme_app_id \
  -e MP_APP_SECRET=changeme_app_secret \
  martin0313/jellyfin-mp:latest

第一次使用

  1. 所有参数设置正确并做完所有准备工作后docker run, JellyfinMP会尝试获取一次微信AccessToken, 并进行一次文章生成, 由于没有任何媒体在数据库所以不会生成任何文章.
  2. 正常在Jellyfin添加媒体(刮削后的, 建议配合TMM使用).
  3. 重启一次容器, JellyfinMP会再次尝试文章生成, 检查Bark通知(如果配置), 在微信公众平台(网页端或者官方订阅号助手APP)检查草稿箱.
  4. 如果没有问题可以将文章群发进行推送, JellyfinMP保持运行即可, 每日9:00进行一次文章生成尝试.

参数说明

MySql数据库 (必填项)

存储Jellyfin媒体具体信息, 用于生成推送文章.

DATABASE_URL: 数据库连接地址

DATABASE_USER: 数据库用户名

DATABASE_PASS: 数据库密码

Jellyfin服务器信息 (必填项)

Jellyfin服务器信息.

JELLYFIN_SERVER_URL: Jellyfin的地址.

JELLYFIN_ADMIN: Jellyfin管理员用户的id, 服务器创建时的第一个用户就可用. 获取方式参考下图:

Jellyfin Admin

JELLYFIN_TOKEN: Jellyfin的API密钥, 在Jellyfin的后台可以生成. 生成后复制API密钥即可. 获取方式参考下图:

Jellyfin API Token

微信公众号开发信息 (必填项)

对接微信公众号必需的信息, 如果没有公众号可参考资料注册一个订阅号即可.

在微信公众平台除了获取到所需的appId和appSecret之外, 还需要填写IP白名单, 因为微信的Token获取是白名单限制的.

MP_APP_ID: 微信公众平台应用ID

MP_APP_SECRET: 微信公众平台应用密钥

获取和填写方式参考下图:

MP_APP

应用本身配置 (非必填)

此应用本身的一些配置选项

UPDATE_DATABASE: 是否更新数据库: 一般来说默认为true即可, 不需要填写此参数, 填写false被用于DEBUG

MP_POST_TO_MP_NEWS: 是否将内容发布到微信普通文章, 一般来说默认为false即可, 不启用这个功能. 这里发布的文章仅仅是从草稿箱发布, 不会推送给订阅用户. 并且不会出现在公众号历史消息中. 具体参考微信文档

MP_SEND_TO_ALL: 是否将内容推送给所有订阅用户. 一般来说默认为false即可, 因为将文章自动推送给订阅用户的能力需要公众号进行认证, 认证有一定的门槛. 这里填写为false, 每天9:00从草稿箱点击一下群发即可, 顺便也可检查一下生成的内容. 具体参考微信文档关于群发消息的说明

Bark推送 (非必填)

Bark 推送Jellyfin媒体处理情况.

BARK_SERVER: BARK服务器地址

BARK_DEVICE: BARK设备ID, 注册BARK服务后可以获得, 详情移步BARK官方仓库说明

Bark

所有参数汇总

参数名 必填 默认值 说明
DATABASE_URL localhost:3306 数据库连接URL
DATABASE_USER user 数据库用户名
DATABASE_PASS pass 数据库密码
UPDATE_DATABASE true 是否更新数据库 (false常用于debug, 默认为true)
BARK_SERVER http://localhost Bark服务器地址
BARK_DEVICE Bark设备标识符
JELLYFIN_ADMIN Jellyfin管理员用户名
JELLYFIN_SERVER_URL Jellyfin服务器URL
JELLYFIN_TOKEN Jellyfin API令牌
MP_POST_TO_MP_NEWS false 是否将内容发布到微信普通文章(truefalse
MP_SEND_TO_ALL false 是否将文章群发推送给订阅用户(truefalse
MP_APP_ID 微信公众平台应用ID
MP_APP_SECRET 微信公众平台应用密钥

jellyfinmp's People

Contributors

mty0313 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.