wynying92/wewe-rss-extensions repository overview

⁠WeWe RSS 扩展管理组件

⁠本项目用于扩展WeWe RSS⁠的部分功能

⁠原理

extensions主程序启动时，会读取容器 /app/data/conf/conf.yaml 路径的配置文件

因此需要在容器启动前，先完成组件配置，用到组件的yaml放在$(pwd)/data/conf/目录下（v0.2.0已支持动态配置并保存）

之后通过-v $(pwd)/data:/app/data，确保容器的/app/data/conf目录挂载到宿主机的$(pwd)/data/conf/目录

⁠功能

• 定时通知机器人，支持飞书，钉钉，自定义...
• 个性化更新配置
• 内容过滤&通知 ...

⁠定时通知机器人

• 支持多个同类型/不同类型的定时通知机器人

  示例⁠中为两个飞书机器人和一个钉钉机器人

• 支持为每个机器人设置独立的通知周期，分钟粒度

⁠个性化更新

• 支持公众号粒度设置更新时间（Cron形式）

• 支持为单一公众号设置多个更新时间，满足任意一个即触发更新

  示例⁠中为两个公众号单独配置了更新时间， 其中一个公众号设置了两个更新时间

⁠部署

⁠Docker Compose

1. 参考 扩展组件配置⁠ 完成相关组件的配置，yaml配置文件放在目录 $(pwd)/data/conf/
   • v0.2.0之后支持通过 http://localhost:4100 动态配置并保存（如果使用动态配置，则跳过第1步，待compose启动后进入页面完成配置）
2. 按需调整 docker compose yaml 文件

• Sqlite版参考 docker-compose.sqlite.yml⁠
• Mysql版参考 docker-compose.yml⁠

1. 启动 docker compose

⁠Docker

⁠Sqlite版

1. 参考 扩展组件配置⁠ 完成相关组件的配置，yaml配置文件放在目录 $(pwd)/data/conf/
   • v0.2.0之后支持通过 http://localhost:4100 动态配置并保存（如果使用动态配置，则跳过第1步，待compose启动后进入页面完成配置）
   • 公网环境下使用，建议参考docker-compose⁠中的Note
2. 参考 Sqlite版命令⁠ 部署好 WeWe Rss
3. 启动 wewe-rss-extensions
   • DATABASE_URL和DATABASE_TYPE与wewe-rss容器的配置保持对应，确保可以共享到wewe-rss.db
   • WEWERSS_ORIGIN_URL设置为wewe-rss的源地址，确保可以通过接口调用到wewe-rss的api

docker run -d \
  --name wewe-rss-extensions \
  -e DATABASE_TYPE=sqlite \
  -e DATABASE_URL="file:../data/wewe-rss.db" \
  -e WEWERSS_ORIGIN_URL=http://127.0.0.1:4000 \
  -v $(pwd)/data:/app/data \
  wynying92/wewe-rss-extensions:latest

⁠Mysql版

1. 参考 扩展组件配置⁠ 完成相关组件的配置，yaml配置文件放在目录 $(pwd)/data/conf/
   • v0.2.0之后支持通过 http://localhost:4100 动态配置并保存（如果使用动态配置，则跳过第1步，待compose启动后进入页面完成配置）
   • 公网环境下使用，建议参考docker-compose⁠中的Note
2. 参考 Mysql版命令⁠ 部署好 WeWe Rss
3. 启动 wewe-rss-extensions
   • network DATABASE_URL和DATABASE_TYPE与wewe-rss容器的配置保持对应，确保可以共享mysql数据库
   • WEWERSS_ORIGIN_URL设置为wewe-rss的源地址，确保可以通过接口调用到wewe-rss的api

docker run -d \
  --name wewe-rss-extensions \
  -e DATABASE_TYPE=mysql \
  -e DATABASE_URL='mysql://root:123456@db:3306/wewe-rss?schema=public&connect_timeout=30&pool_timeout=30&socket_timeout=30' \
  -e WEWERSS_ORIGIN_URL=http://127.0.0.1:4000 \
  -v $(pwd)/data:/app/data \
  --network wewe-rss \
  wynying92/wewe-rss-extensions:latest

⁠License

MIT⁠ @wyn-ying