• 此分支为v3.0版本

ShadowsocksR-support

一个在服务器端生成ShadowsockR服务器订阅以及维护进程存活的简单实现

设计目的

• 防止因为DNS解析导致SSR服务器ip被BAN
• 防止SSR进程因意外被终止
• 降低因服务器新增/迁移，SSR设置更新等的工作量

插件

1. ssrs
   • 用于读取ssr/ss配置文件,生成ssr://链接
2. ssrs_server
   • 用于汇总多个ssrs插件生成的链接,并提供适用于SSR客户端的服务器订阅

关于插件

1. ssrs与ssrs_server需要配合使用
2. ssrs可以与ssrs_server在不同服务器上(设计如此),也可在同一台服务器上
3. 允许添加新的插件,参见 自定义插件

部署方式

1. 拷贝src目录到服务器
2. 拷贝requirements.txt到服务器
3. 执行pip install -r requirements.txt安装依赖
4. 到src/service/plugins启用/禁用插件（禁用方式为删除或在文件夹前加入两个下划线__）
5. 使用gunicorn或其他wsgi来启动服务器（一条建议的命令nohup gunicorn -c gun.conf main:app &>gunicorn.log &）

• 一条用于重新加载SSRS配置/重启SSRS的命令：cat gunicorn.pid |xargs kill -HUP

config.yaml配置文件

• config.yaml在相应的插件目录下

• ssrs_server插件的config.yaml

  group: PowerByBafflingBUG                         # SSR GROUP
  token: password                                   # 服务器间token，必须和代理服务器相同字段保持一致(弱验证)
  password: 696d29e0940a4957748fe3fc9efd22a3        # 客户连接中介服务器使用的password，此处填写值为原始密钥经过[两次]md5加密以后的值(32位/小写/强验证)
  

• ssrs插件的config.yaml

  host: 0.0.0.0                                     # 本机公网
  server: http://127.0.0.1:80                       # 本机web服务器地址,用于ssrs_server访问ssrs(如果部署在同一台机器上可以使用环回地址)
  reg_server: http://example.com/ssrs_server/       # ssrs的地址(用于注册一个代理服务器,由于插件名的可变性请带上插件名）
  token: password                                   # 服务器间token，必须和中介服务器相同字段保持一致(弱验证)
  ssr:                                              # 兼容SS
      - config_file: /etc/shadowsocksR/config.json  # SSR进程的配置文件路径(完整路径)
        remarks: ssr                                # SSR进程的备注名(请勿使用中文，空格，特殊符号等)
        restart: /etc/init.d/shadowsocksR restart   # SSR进程的重启命令
      # 第二个SSR进程(可选)
      - config_file:
        remarks:
        restart:
  

SSR服务器订阅地址

http(s)://[main-server]/<ssrs plugins name>/?pw=[password]

此处user-token为未加密的明文

示例：http://example.com/ssrs/?pw=password

自定义插件

1. 插件的工作方式
   • 使用flask的Blueprint实现
   • 访问插件的url为host[:port]/<plugins name>/<path>
   • 插件文件存放于src/service/plugins/<plugins name>下
2. 插件名
   • 插件名即其plugins下的文件夹名,更改文件夹名会使得插件url产生相同改动
3. 如何编写插件
   1. 建立插件的目录
   2. 在插件目录下建立__init__py
   3. __init__.py里需要有一个类型为flask.Blueprint的blueprint变量
   4. 使用flask编写代码

写在最后

• 这个一个个人项目，没有做很多的兼容性判断。可能会在其他环境下无法运行
• python的运行环境是python3+
• 如果难以看懂教程尝试切换分支到以前的版本(我也觉得如此)