Skip to content

Latest commit

 

History

History
697 lines (552 loc) · 35.5 KB

configuration.md

File metadata and controls

697 lines (552 loc) · 35.5 KB
Raw

配置说明

[目录]

1. 配置方式

1.1. 方式一：修改配置文件

推荐使用Release包在本地运行的朋友使用，直接打开文件，将对应的配置值填入，保存即可生效。

默认有3个配置文件：appsettings.json、appsettings.Development.json、appsettings.Production.json，分别对应默认、开发与生产环境。

如果运行环境为开发环境，则appsettings.Development.json优先级高于appsettings.json，即appsettings.Development.json里的配置会覆盖默认配置（不是全部覆盖，appsettings.Development.json里加了几个就覆盖几个）；

如果运行环境为生产环境，则appsettings.Production.json优先级高于appsettings.json，即appsettings.Production.json里的配置会覆盖默认配置（同样不是全部覆盖，appsettings.Production.json里加了几个就覆盖几个）。

对于不是开发人员的大部分人来说，只需要关注appsettings.Production.json即可，因为非调试状态下运行的默认环境就是生产环境。此时如需自定义配置，推荐在appsettings.Production.json文件中进行修改（并且以后都只修改appsettings.Production.json文件，appsettings.json只作为默认模板而存在）

1.2. 方式二：命令启动时通过命令行参数配置

在使用命令行启动时，可使用-key=value的形式附加配置，所有可用的命令行参数均在 命令行参数映射 文件中。

  • 使用跨平台的依赖包

各个系统只要安装了net5环境，均可使用dotnet命令启动，命令样例：

dotnet Ray.BiliBiliTool.Console.dll -cookieStr=abc -numberOfCoins=5
  • Windows系统

使用自包含包（win-x86-x64.zip），命令样例：

Ray.BiliBiliTool.Console.exe -cookieStr=abc -numberOfCoins=5
  • Linux系统

使用自包含包（linux.zip），命令样例：

Ray.BiliBiliTool.Console -cookieStr=abc -numberOfCoins=5

如映射文件所展示，支持使用命令行配置的配置项并不多，也不建议大量地使用该种方式进行配置。使用包运行地朋友，除了改配置文件和命令行参数配置外，还可以使用环境变量进行配置，这也是推荐的做法，如下。

1.3. 方式三：添加环境变量

所有的配置项均可以通过添加环境变量来进行配置，以Windows下依赖net5的系统为例：

set Ray_RunTasks=Daily
set Ray_BiliBiliCookies__1=abc
set Ray_BiliBiliCookies__2=efg
set Ray_DailyTaskConfig__NumberOfCoins=3
dotnet Ray.BiliBiliTool.Console.dll

注意区分单下划线和双下划线，linux系统使用export关键字代替set。

1.4. 方式四：托管在GitHub Actions上，使用GitHub Secrets配置

使用GitHub Actions，可以通过添加Secret实现配置。

比如，配置微信推送的SCKEY，可以添加如下Secret：

Secret Name：PUSHSCKEY

Secret Value：123abc

这些 Secrets 会通过 workflow 里的yml脚本映射为环境变量，在应用启动时作为环境变量配置源传入程序当中，所以使用 GitHub Secrets 配置的本质是使用环境变量配置。

添加GitHub Secrets

2. 优先级

以上 4 种配置源，其优先级由低到高依次是：json文件 < 环境变量(和Github Secrets) < 命令行。

即，如果既在配置文件中写入了配置值，又在命令行启动时使用命令行参数指定了配置值，则最后会使用命令行的。

对于使用 Github Action 线上运行的朋友，建议只使用 Secrets 进行配置。 因为 Fork 项目后，不会拷贝源仓库中的 Secrets，可自由的在自己的仓库中进行私人配置。当有新版本发布时，同步仓库会很顺滑，不会影响到已配置的值。

当然， Fork 之后自己改了 appsettings.json 文件再提交，也是可以实现配置的。但是一则你的配置值将被暴露出来（别人可通过访问你的仓库里的配置查看到值），二是以后如果需要 PR 源仓库的更新到自己仓库，则要注意保留自己的修改不要被同步操作覆盖。

3. 详细配置说明

3.1. CookieStr（Cookie字符串）

没有它，程序的运行就没有意义，所以它是必填项。

TITLE CONTENT
意义 Cookie字符串1
值域 字符串，英文分号分隔，来自浏览器抓取
默认值 空
环境变量示范 set Ray_BiliBiliCookies__1=abc=123;def=456;
命令行示范 无
GitHub Secrets 示范 Name:COOKIESTR Value: abc=123;def=456;
TITLE CONTENT
意义 Cookie字符串2
值域 字符串，英文分号分隔，来自浏览器抓取
默认值 空
环境变量示范 set Ray_BiliBiliCookies__2=abc=123;def=456;
命令行示范 无
GitHub Secrets 示范 Name:COOKIESTR2 Value: abc=123;def=456;
TITLE CONTENT
意义 Cookie字符串2
值域 字符串，英文分号分隔，来自浏览器抓取
默认值 空
环境变量示范 set Ray_BiliBiliCookies__3=abc=123;def=456;
命令行示范 无
GitHub Secrets 示范 Name:COOKIESTR3 Value: abc=123;def=456;

3.2. 安全相关的配置

3.2.1. IsSkipDailyTask（是否跳过执行任务）

用于特殊情况下，通过配置灵活的开启和关闭整个应用. 配置为关闭后，程序会跳过所有任务，不会调用B站任何接口。

TITLE CONTENT
意义 是否跳过执行任务
值域 [true,false]
默认值 false
环境变量示范 set Ray_Security__IsSkipDailyTask=true
命令行示范 无
GitHub Secrets 示范 Name:ISSKIPDAILYTASK Value: true

若想要彻底关闭，即Actions不运行，点击Actions进入Workflows列表，点击相应任务（如bilibili-daily-task.yml）的Workflow，在搜索框右侧有一个三个点的设置按钮，点击按钮后，在弹出的下拉列表里选中Disable workflow项即可。

3.2.2. RandomSleepMaxMin（随机睡眠的最大时长）

用于设置程序启动后，随机睡眠时间的最大上限值，单位为分钟。

默认为10，即程序每天运行后会随机睡眠1到10分钟。这样可以避免程序每天准点地在同一时间运行，太像机器。

配置为0则不进行睡眠。

TITLE CONTENT
意义 随机睡眠时长的最大值
值域 数字
默认值 10
环境变量示范 set Ray_Security__RandomSleepMaxMin=20
命令行示范 -randomSleepMaxMin=20
GitHub Secrets 示范 Name:RANDOMSLEEPMAXMIN Value: 20

3.2.3. IntervalSecondsBetweenRequestApi（两次调用B站Api之间的间隔秒数）

因为有朋友反馈，程序在1到2秒内连续调用B站的Api过快，担心会被B站的安全策略检测到，影响自己的账号安全。

所以我添加这个安全策略的配置，可以设置两次Api请求之间的最短时间间隔。

举例来说，之前的5次投币可能是在1秒之内完成的，现在通过配置间隔时间，可以将其变为投币一次后，经过4到5秒才会投下一个，提升程序的演技，让它表现的就像真人在投币一样，骗过BiliBili~

TITLE CONTENT
意义 两次调用B站Api之间的间隔秒数
值域 [0,+]
默认值 3
环境变量示范 set Ray_Security__IntervalSecondsBetweenRequestApi=20
命令行示范 -intervalSecondsBetweenRequestApi=10
GitHub Secrets 示范 Name:INTERVALSECONDSBETWEENREQUESTAPI Value: 10

3.2.4. IntervalMethodTypes（间隔秒数所针对的HttpMethod）

间隔秒数所针对的HttpMethod类型，服务于上一个配置。服务器一般对GET请求不是很敏感，建议只针对POST请求做间隔就可以了。

TITLE CONTENT
意义 两次调用B站Api之间的间隔秒数
值域 [GET,POST]，多个以英文逗号分隔
默认值 POST
环境变量示范 set Ray_Security__IntervalMethodTypes=GET,POST
命令行示范 -intervalMethodTypes=GET,POST
GitHub Secrets 示范 Name:INTERVALMETHODTYPES Value: GET,POST

3.2.5. UserAgent（请求B站接口时头部传递的User-Agent）

近期出现登录接口报错412（#61）,有朋友发现通过修改UA可以暂时解决问题，所以开放为了配置。

TITLE CONTENT
意义 请求B站接口时头部传递的User-Agent
值域 字符串，可以F12从自己的浏览器获取
默认值 Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36 Edg/87.0.664.41
环境变量示范 set Ray_Security__UserAgent=abc
命令行示范 不开放命令行
GitHub Secrets 示范 Name:USERAGENT Value: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.66 Safari/537.36 Edg/87.0.664.41

获取浏览器中自己的UA的方法见下图：

获取User-Agent

3.2.6. WebProxy（代理）

支持需要账户密码的代理。

TITLE CONTENT
意义 调用api时的全局代理
值域 字符串，形如：user:password@host:port
默认值 无
环境变量示范 set Ray_Security__WebProxy=127.0.0.1:10240
命令行示范 不开放命令行
GitHub Secrets 示范 Name:WEBPROXY Value: user:password@host:port

3.3. 每日任务相关

3.3.1. NumberOfCoins（每日投币数量）

每天投币的总目标数量，因为投币获取经验只与次数有关，所以程序每次投币只会投1个，也就是说该配置也表示每日投币次数。

TITLE CONTENT
意义 每天投币的总目标数量
值域 [0,5]，为安全考虑，程序内部还会做验证，最大不能超过5
默认值 5
环境变量示范 set Ray_DailyTaskConfig__NumberOfCoins=abc
命令行示范 -numberOfCoins=3
GitHub Secrets 示范 Name:NUMBEROFCOINS Value: 3

3.3.2. SelectLike（投币时是否同时点赞）

TITLE CONTENT
意义 投币时是否同时点赞
值域 [true,false]
默认值 false
环境变量示范 set Ray_DailyTaskConfig__SelectLike=true
命令行示范 -selectLike=true
GitHub Secrets 示范 Name:SELECTLIKE Value: true

3.3.3. SupportUpIds（优先选择支持的up主Id集合）

专门为强迫症的朋友准备的配置。有人觉得随机选择视频来观看、分享和投币，一则不是自己的真实意愿，二则担心会影响B站对个人的喜好猜测产生偏差，导致以后推荐的视频都并不是自己真正喜欢的。

所以就有这个配置，通过填入自己选择的up主ID，则以后观看、分享和投币，都会优先从配置的up主下面挑选视频，如果没有找到才去其他地方随机挑选视频。

其优先等级是最高的，如果配置了，在投币或观看、分享视频时，会优先从配置的up主中随机获取视频。

程序会最多尝试随机获取10次，如果10均未获取到可投币的视频（比如都已经投过，不能重复投了），则会去你的特别关注列表中随机再获取，再然后会去普通关注列表中随机获取，最后会去排行榜中随机获取。

注意：该配置的默认值是作者的upId，如需换掉的话，直接更改即可。

TITLE CONTENT
意义 优先选择支持的up主Id集合
值域 up主ID，多个用英文逗号分隔，默认是作者本人的UpId，如需删除可以配置为空格字符串或“-1”，也可以配置为其他人的UpId
默认值 作者的upId
环境变量示范 set Ray_DailyTaskConfig__SupportUpIds=220893216,17819768,43619319,14583962,44473221,123938419,34858100
命令行示范 -supportUpIds=220893216,17819768,43619319,14583962,44473221,123938419,34858100
GitHub Secrets 示范 Name:SUPPORTUPIDS Value: 220893216,17819768,43619319,14583962,44473221,123938419,34858100

获取UP主的Id方法：打开bilibili，进入欲要选择的UP主主页，在url中和简介中，都可获得该UP主的Id，如下图所示：

UpId

3.3.4. DayOfAutoCharge（每月几号自动充电）

使用大会员免费赠送的B币券自动充电，如不使用，每个月结束会自动失效。没有B币券或B币券余额不足2，不会进行充电。

TITLE CONTENT
意义 每月几号自动充电
值域 [-1,31]，-1表示不指定，默认月底最后一天；0表示不充电
默认值 -1
环境变量示范 set Ray_DailyTaskConfig__DayOfAutoCharge=25
命令行示范 -dayOfAutoCharge=25
GitHub Secrets 示范 Name:DAYOFAUTOCHARGE Value: 25

3.3.5. AutoChargeUpId（充电对象）

充电对象的upId，需要配合前一个DayOfAutoCharge配置项使用。-1表示不指定，默认为自己充电；其他Id则会尝试为配置的UpId充电。

注意：该配置的默认值是作者的upId，如果你已认证通过了创作身份（即可以为自己充电），则建议将其改为为自己充电（配置为-1即可），也可以配置为某个自己指定的创作者upId。 当然我个人不阻止大佬们把Id配成我的，个人维护开源不易，感谢支持~

TITLE CONTENT
意义 充电对象的Id
值域 up的Id字符串，默认是作者本人的UpId；-1表示不指定，为自己充电；其他Id则会尝试为配置的UpId充电
默认值 作者的upId
环境变量示范 set Ray_DailyTaskConfig__AutoChargeUpId=220893216
命令行示范 -autoChargeUpId=220893216
GitHub Secrets 示范 Name:AUTOCHARGEUPID Value: 220893216

3.3.6. DayOfReceiveVipPrivilege（每月几号自动领取会员权益）

TITLE CONTENT
意义 每月几号自动领取会员权益
值域 [-1,31]，-1表示不指定，默认每月1号；0表示不领取
默认值 1
环境变量示范 set Ray_DailyTaskConfig__DayOfReceiveVipPrivilege=2
命令行示范 -dayOfReceiveVipPrivilege=2
GitHub Secrets 示范 Name:DAYOFRECEIVEVIPPRIVILEGE Value: 2

3.3.7. DayOfExchangeSilver2Coin（每月几号进行直播中心银瓜子兑换硬币）

TITLE CONTENT
意义 每月几号进行直播中心银瓜子兑换硬币
值域 [-1,31]，-1表示不指定，默认每月最后一天；-2表示每天；0表示不进行兑换
默认值 -1
环境变量示范 set Ray_DailyTaskConfig__DayOfExchangeSilver2Coin=1
命令行示范 -dayOfExchangeSilver2Coin=1
GitHub Secrets 示范 Name:DayOfExchangeSilver2Coin Value: 1

3.4. 天选时刻抽奖相关

3.4.1. ExcludeAwardNames（根据关键字排除奖品）

TITLE CONTENT
意义 根据关键字排除奖品，当奖品名称中包含这些关键字时，不参与抽奖
值域 一串字符串，多个关键字使用|符号隔开
默认值 舰|船|航海|代金券|自拍|照|写真|图
环境变量示范 set Ray_LiveLotteryTaskConfig__ExcludeAwardNames=舰|船|航海|代金券
命令行示范 -excludeAwardNames=舰|船|航海|代金券
GitHub Secrets 示范 Name:EXCLUDEAWARDNAMES Value: 舰|船|航海|代金券

3.4.2. IncludeAwardNames（根据关键字指定奖品）

TITLE CONTENT
意义 根据关键字指定奖品，只有当奖品名称中包含这些关键字时，才参与抽奖，否则不参与
值域 一串字符串，多个关键字使用|符号隔开
默认值 空
环境变量示范 set Ray_LiveLotteryTaskConfig__IncludeAwardNames=红包|现金|元|块|支付宝
命令行示范 -includeAwardNames=红包|现金|元|块|支付宝
GitHub Secrets 示范 Name:INCLUDEAWARDNAMES Value: 红包|现金|元|块|支付宝

3.4.3. AutoGroupFollowings（天选抽奖后是否自动分组关注的主播）

TITLE CONTENT
意义 天选抽奖后是否自动分组关注的主播
值域 [true,false]
默认值 true
环境变量示范 set Ray_LiveLotteryTaskConfig__AutoGroupFollowings=true
命令行示范 无
GitHub Secrets 示范 Name:AUTOGROUPFOLLOWINGS Value: true

3.5. 批量取关相关

3.5.1. GroupName（想要批量取关的分组名称）

TITLE CONTENT
意义 想要批量取关的分组名称
值域 字符串
默认值 天选时刻
环境变量示范 set Ray_UnfollowBatchedTaskConfig__GroupName=默认分组
命令行示范 无
GitHub Secrets 示范 无，在unfollow-batched-task.yml工作流中通过input输入

3.5.2. Count（批量取关的人数）

TITLE CONTENT
意义 分组下要取关的人数，从后往前取关
值域 数字，[-1,+]，-1表示全部
默认值 2
环境变量示范 set Ray_UnfollowBatchedTaskConfig__Count=-1
命令行示范 无
GitHub Secrets 示范 无，在unfollow-batched-task.yml工作流中通过input输入

3.6. 推送相关

v1.0.x仅支持推送到Server酱，v1.1.x之后重新定义了推送地概念，将推送仅看作不同地日志输出端，与Console、File没有本质区别。

配置多个，多个端均会收到日志消息。推荐Telegram、企业微信、Server酱。

3.6.1. Telegram机器人

TG推送效果

3.6.1.1. botToken

点击 https://core.telegram.org/api#bot-api 查看如何创建机器人并获取到机器人的botToken。

TITLE CONTENT
意义 用于将日志输出到Telegram机器人
值域 一串字符串
默认值 空
环境变量示范
命令行示范 无
GitHub Secrets 示范 Name:PUSHTGTOKEN Value: 123456:abcdefg

3.6.1.2. chatId

点击 https://api.telegram.org/bot{TOKEN}/getUpdates 获取到与机器人的chatId（需要用上面获取到的Token替换进链接里的{TOKEN}后访问）

P.S.访问链接需要能访问“外网”，有vpn的挂vpn。

TITLE CONTENT
意义 用于将日志输出到Telegram机器人
值域 一串字符串
默认值 空
环境变量示范
命令行示范 无
GitHub Secrets 示范 Name:PUSHTGCHATID Value: 654321

3.6.2. 企业微信机器人

在群内添加机器人，获取到机器人的WebHook地址，添加到配置中。

企业微信推送效果

3.6.2.1. webHookUrl
TITLE CONTENT
意义 用于将日志输出到企业微信机器人
值域 一串字符串
默认值 空
环境变量示范
命令行示范 无
GitHub Secrets 示范 Name:PUSHWEIXINURL Value: abcdefg

3.6.3. 钉钉机器人

在群内添加机器人，获取到机器人的WebHook地址，添加到配置中。

机器人的安全策略，当前不支持加签，请使用关键字策略，推荐关键字：Ray 或 BiliBili

钉钉推送效果

3.6.3.1. webHookUrl
TITLE CONTENT
意义 用于将日志输出到钉钉机器人
值域 一串字符串
默认值 空
环境变量示范
命令行示范 无
GitHub Secrets 示范 Name:PUSHDINGURL Value: abcdefg

3.6.4. Server酱

官网： http://sc.ftqq.com/9.version

Server酱推送效果

3.6.4.1. TurboScKey（Server酱SCKEY）

获取方式请参考官网。

TITLE CONTENT
意义 用于微信推送的SCKEY
值域 一串字符串
默认值 空
环境变量示范 set Ray_Serilog__WriteTo__6__Args__turboScKey=abcdefg
命令行示范
GitHub Secrets 示范 Name:PUSHSERVERTSCKEY Value: abcdefg

3.6.5. 酷推

https://cp.xuthus.cc/

3.6.5.1. sKey

该平台可能还在完善当中，对接时我发现其接口定义不规范，且机器人容易被封，所以不推荐使用，且不接受提酷推推送相关bug。

TITLE CONTENT
意义 用于将日志输出到QQ
值域 一串字符串
默认值 空
环境变量示范
命令行示范 无
GitHub Secrets 示范 Name:PUSHCOOLSKEY Value: abcdefg

3.6.6. 推送到自定义Api

这是我简单封装了一个通用的推送接口，可以推送到任意的api地址，如果有自己的机器人或自己的用于接受日志的api，可以根据需要自定义配置。

3.6.6.1. api
TITLE CONTENT
意义 自定义用来接受日志的api地址
值域 一串字符串
默认值 空
环境变量示范
命令行示范 无
GitHub Secrets 示范 Name:PUSHOTHERAPI Value: abcdefg
3.6.6.2. placeholder
TITLE CONTENT
意义 占位符
值域 一串字符串
默认值 空
环境变量示范
命令行示范 无
GitHub Secrets 示范 Name:PUSHOTHERPLACEHOLDER Value: #msg#
3.6.6.3. bodyJsonTemplate
TITLE CONTENT
意义 post发送的body，格式为json字符串
值域 一串字符串
默认值 空
环境变量示范
命令行示范 无
GitHub Secrets 示范 Name:PUSHOTHERBODYJSONTEMPLATE Value: {\"content\":#msg#}

3.6.7. PushPlus[推荐]

官网： http://www.pushplus.plus/doc/

3.6.7.1. Token（PushPlus的Token）

获取方式请参考官网。

TITLE CONTENT
意义 用于推送的Token
值域 一串字符串
默认值 空
环境变量示范 set Ray_Serilog__WriteTo__9__Args__token=abcdefg
命令行示范
GitHub Secrets 示范 Name:PUSHPLUSTOKEN Value: abcdefg

3.6.7.2. Topic（PushPlus的Topic）

获取方式请参考官网。

TITLE CONTENT
意义 用于设置群发
值域 一串字符串
默认值 空
环境变量示范 set Ray_Serilog__WriteTo__9__Args__topic=abcdefg
命令行示范
GitHub Secrets 示范 Name:PUSHPLUSTOPIC Value: abcdefg

3.6.7.3. Channel（PushPlus的Channel）

获取方式请参考官网。

TITLE CONTENT
意义 用于设置推送通道
值域 一串字符串，[wechat,webhook,cp,sms,mail]
默认值 空
环境变量示范 set Ray_Serilog__WriteTo__9__Args__channel=abcdefg
命令行示范
GitHub Secrets 示范 Name:PUSHPLUSCHANNEL Value: wechat

3.6.7.4. Webhook（PushPlus的Webhook）

获取方式请参考官网。

TITLE CONTENT
意义 webhook编码(不是地址)，在官网平台设定，仅在channel使用webhook渠道和CP渠道时需要填写
值域 一串字符串
默认值 空
环境变量示范 set Ray_Serilog__WriteTo__9__Args__webhook=abcdefg
命令行示范
GitHub Secrets 示范 Name:PUSHPLUSWEBHOOK Value: abc

3.7. 日志相关

3.7.1. ConsoleLogLevel（日志输出等级）

这里的日志等级指的是 Console 的等级，即 GitHub Actions 里和微信推送里看到的日志。

为了美观， BiliBiliTool 默认只输出最低等级为 Information 的日志，保证只展示最精简的信息。

但是经过几轮反馈发现，这样会造成 GitHub Actions 运行的朋友遇到异常时无法查看详细日志信息（本地运行的朋友可以通过日志文件看到详细的日志信息）。

所以就将日志等级开放为配置了，通过更改等级，可以指定日志输出的详细程度。

BiliBiliTool 使用 Serilog 作为日志组件，所以其值域与 Serilog 的日志等级选项相同，这里只建议在需要调试时改为Debug，应用会输出详细的调试日志信息，包括每次调用B站Api的请求参数与返回数据。

TITLE CONTENT
意义 设置Console输出的日志的详细程度
值域 [Information,Debug]
默认值 1
环境变量示范
命令行示范 暂未开放到命令行
GitHub Secrets 示范 Name:CONSOLELOGLEVEL Value: Debug

3.7.2. ConsoleLogTemplate（日志输出样式）

这里的日志样式指的是 Console 的等级，即 GitHub Actions 里和微信推送里看到的日志。

通过更改模板样式，可以指定日志输出的样式，比如不输出时间和等级，做到最精简的样式。

BiliBiliTool 使用 Serilog 作为日志组件，所以可以参考 Serilog 的日志样式模板。

TITLE CONTENT
意义 设置Console输出的日志样式
值域 字符串
默认值 [{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}
环境变量示范
命令行示范 太长了，不考虑开放到命令行
GitHub Secrets 示范 Name:CONSOLELOGTEMPLATE Value: {Message:lj}{NewLine}{Exception}