Skip to content

Commit

Permalink
Merge pull request #318 from hjkl950217/main
Browse files Browse the repository at this point in the history
增加代理和切换配置文件的说明
  • Loading branch information
RayWangQvQ authored Dec 15, 2020
2 parents 28d872e + b2d59a0 commit d6cb153
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ _P.S.如果自己有服务器,也可以将程序发布到自己的服务器,

### 2.2.配置方式

目前支持的配置源有 3 种:appsettings.json 配置文件、环境变量、命令行参数,外加一种专用于 Actions 模式使用的 GitHub Secrets 配置源。
目前支持的配置源有 3 种:`appsettings.json` 配置文件、环境变量、命令行参数,外加一种专用于 Actions 模式使用的 GitHub Secrets 配置源。

#### 配置源一:appsettings.json 文件

Expand Down Expand Up @@ -196,18 +196,34 @@ dotnet run -p ./src/Ray.BiliBiliTool.Console -userId=123 -sessData=456 -biliJct=

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

### 2.4 按环境切换配置
增加指定不同环境来加载配置文件的功能(增加一个自己的避免更新配置被覆盖),仅针对`appsettings.json`中的配置。使用方法:

## 3.常见问题
1. 复制一个`appsettings.json`文件, 改为`appsettings.PRD.json`,中间这个`PRD`你也可以取其它名字,设置环境变量时匹配即可。
2. 删除所有配置,然后把你想要修改的设置项复制过来,修改为你想要的值。
3. 设置环境变量

【github action】 : 在secrets中增加`ENV`,值为刚才取的名字
【本地运行或docker】: 设置环境变量`ASPNETCORE_ENVIRONMENT`=`刚才取的名字`


## 3.代理
增加代理支持,如果需要请看:
1. 【github action】 : 在secrets中增加`PROXY`,值为代理地址+端口,如`127.0.0.1:10240`
2. 【本地运行或docker】: 设置环境变量`RAY_WebProxy`=`代理地址,格式如上`


## 4.常见问题

[>>点击查看常见问题列表](https://hub.fastgit.org/RayWangQvQ/BiliBiliTool.Docs/blob/main/questions.md)

## 4.版本发布
## 5.版本发布

当前正处于稳定的迭代开发中,正常情况下每周会发布一个小版本,详细待更新内容可参见源码中的 todo 任务列表。

关于版本发布更新后,如何同步最新的内容到自己 Fork 的仓库,可查看[>>常见问题文档](https://hub.fastgit.org/RayWangQvQ/BiliBiliTool.Docs/blob/main/questions.md) 中的 **我 Fork 之后怎么同步原作者的更新内容?**

## 5.贡献代码
## 6.贡献代码

如果你有好的想法,欢迎向仓库贡献你的代码,贡献步骤:

Expand All @@ -219,7 +235,7 @@ dotnet run -p ./src/Ray.BiliBiliTool.Console -userId=123 -sessData=456 -biliJct=

我会尽快进行代码审核,提前感谢你的贡献。

## 6.捐赠支持
## 7.捐赠支持

[>>点击查看已捐赠列表和留言](https://hub.fastgit.org/RayWangQvQ/BiliBiliTool.Docs/blob/main/donate-list.md)

Expand All @@ -241,7 +257,7 @@ dotnet run -p ./src/Ray.BiliBiliTool.Console -userId=123 -sessData=456 -biliJct=

![支付宝赞赏码](https://cdn.jsdelivr.net/gh/RayWangQvQ/BiliBiliTool.Docs@main/imgs/donate-ali.jpg)

## 7.API 参考
## 8.API 参考

- [JunzhouLiu/BILIBILI-HELPER](https://github.com/JunzhouLiu/BILIBILI-HELPER)
- [happy888888/BiliExp](https://github.com/happy888888/BiliExp)

0 comments on commit d6cb153

Please sign in to comment.