docs: 完善 README
This commit is contained in:
Mmx233
108
README.md
108
README.md
@@ -4,22 +4,22 @@
|
||||
[](https://github.com/Mmx233/BitSrunLoginGo/releases)
|
||||
[](https://goreportcard.com/report/github.com/Mmx233/BitSrunLoginGo)
|
||||
|
||||
深澜校园网登录脚本Go语言版。GO语言可以直接交叉编译出mips架构可执行程序（路由器）（主流平台更不用说了），从而免除安装环境。
|
||||
深澜校园网登录脚本 Go 语言版。GO 语言可以直接交叉编译出 mips 架构可执行程序（路由器）（主流平台更不用说了），从而免除安装环境。
|
||||
|
||||
> 主要登录逻辑来自： https://github.com/coffeehat/BIT-srun-login-script
|
||||
|
||||
> 对Openwrt更加友好的ipk编译版： [Mmx233/BitSrunLoginGo_Openwrt](https://github.com/Mmx233/BitSrunLoginGo_Openwrt) ，该版本压缩了binary文件，节省闪存空间
|
||||
> 对 OpenWrt 更加友好的 ipk 编译版： [Mmx233/BitSrunLoginGo_Openwrt](https://github.com/Mmx233/BitSrunLoginGo_Openwrt) ，该版本压缩了 binary 文件，节省闪存空间
|
||||
|
||||
## :hammer_and_wrench:构建
|
||||
|
||||
**\*运行程序不需要golang环境**
|
||||
**\*运行程序不需要 golang 环境**
|
||||
|
||||
请安装最新版golang
|
||||
请安装最新版 golang
|
||||
|
||||
直接编译本系统可执行程序：
|
||||
|
||||
```shell
|
||||
go build
|
||||
go build -ldflags "-s -w -extldflags '-static'"
|
||||
```
|
||||
|
||||
交叉编译（Linux）：
|
||||
@@ -28,7 +28,7 @@ go build
|
||||
export GOGGC=0
|
||||
export GOOS=windows #系统
|
||||
export GOARCH=amd64 #架构
|
||||
go build
|
||||
go build -ldflags "-s -w -extldflags '-static'"
|
||||
```
|
||||
|
||||
交叉编译（Powershell）：
|
||||
@@ -37,18 +37,18 @@ go build
|
||||
$env:GOGGC=0
|
||||
$env:GOOS='linux' #系统
|
||||
$env:GOARCH='amd64' #架构
|
||||
go build
|
||||
go build -ldflags "-s -w -extldflags '-static'"
|
||||
```
|
||||
|
||||
golang支持的系统与架构请自行查询
|
||||
golang 支持的系统与架构请自行查询
|
||||
|
||||
## :gear:运行
|
||||
|
||||
编译结果为可执行文件，直接启动即可
|
||||
|
||||
可以通过添加启动参数`--config`指定配置文件路径，默认为当前目录的`Config.yaml`
|
||||
可以通过添加启动参数 `--config` 指定配置文件路径，默认为当前目录的 `Config.yaml`
|
||||
|
||||
支持`json`、`yaml`、`yml`、`toml`、`hcl`、`tfvars`等，仅对`json`和`yaml`进行了优化与测试
|
||||
支持 `json`、`yaml`、`yml`、`toml`、`hcl`、`tfvars` 等，仅对 `json`和`yaml` 进行了优化与测试
|
||||
|
||||
```shell
|
||||
./autoLogin --config=/demo/i.json
|
||||
@@ -56,63 +56,69 @@ golang支持的系统与架构请自行查询
|
||||
|
||||
首次运行将自动生成配置文件
|
||||
|
||||
Config.json说明：
|
||||
Config.yaml 说明：
|
||||
|
||||
```yaml
|
||||
form:
|
||||
domain: www.msftconnecttest.com #登录地址 ip 或域名
|
||||
username: "" #账号
|
||||
usertype: cmcc #运营商类型，详情看下方
|
||||
password: "" #密码
|
||||
meta: #登录参数
|
||||
"n": "200"
|
||||
type: "1"
|
||||
acid: "5"
|
||||
enc: srun_bx1
|
||||
settings:
|
||||
basic: #基础设置
|
||||
https: false #访问校园网 API 时使用 https 协议
|
||||
skip_cert_verify: false #跳过证书有效校验
|
||||
timeout: 5 #网络请求超时时间（秒，正整数）
|
||||
interfaces: "" #网卡名称正则（注意转义），如：eth0\.[2-3]，不为空时为多网卡模式
|
||||
guardian: #守护模式（后台常驻）
|
||||
enable: false
|
||||
duration: 300 #网络检查周期（秒，正整数）
|
||||
daemon: #后台挂起（不建议 windows 使用，windows 请使用系统计划任务）
|
||||
enable: false
|
||||
path: .BitSrun #守护监听文件路径，用于确保只有单守护运行
|
||||
debug: #debug模式，将打印更多日志
|
||||
enable: false
|
||||
write_log: false #写日志文件
|
||||
log_path: ./ #日志文件存放目录路径
|
||||
|
||||
```json5
|
||||
{
|
||||
"form": {
|
||||
"domain": "www.msftconnecttest.com", //登录地址ip或域名
|
||||
"username": "", //账号
|
||||
"user_type": "cmcc", //运营商类型，详情看下方
|
||||
"password": "" //密码
|
||||
},
|
||||
"meta": { //登录参数
|
||||
"n": "200",
|
||||
"type": "1",
|
||||
"acid": "5",
|
||||
"enc": "srun_bx1"
|
||||
},
|
||||
"settings": {
|
||||
"basic": { //基础设置
|
||||
"https": false, //访问校园网API时直接使用https URL
|
||||
"skip_cert_verify": false, //是否忽略证书验证
|
||||
"interfaces": "", //网卡名称正则（注意JSON转义），如：eth0\\.[2-3]，不为空时为多网卡模式
|
||||
"timeout": 5 //网络请求超时时间（秒）
|
||||
},
|
||||
"guardian": { //守护模式
|
||||
"enable": false,
|
||||
"duration": 300, //网络检查周期（秒）
|
||||
},
|
||||
"daemon": { //后台模式（不建议windows使用）
|
||||
"enable": false,
|
||||
"path": ".BitSrun", //守护监听文件路径，确保只有单守护运行
|
||||
},
|
||||
"debug": {
|
||||
"enable": false, //开启debug模式，报错将更加详细
|
||||
"write_log": false, //写日志文件
|
||||
"log_path": "./" //日志文件存放路径
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
登录参数从原网页登陆时对`/srun_portal`的请求抓取，抓取时请把浏览器控制台的`preserve log`（保留日志）启用。
|
||||
登录参数从原网页登陆时对 `/srun_portal` 的请求抓取，抓取时请把浏览器控制台的 `preserve log`（保留日志）启用。
|
||||
|
||||
运营商类型在原网页会被自动附加在账号后，请把`@`后面的部分填入`user_type`，没有则留空（删掉默认的）
|
||||
运营商类型在原网页会被自动附加在账号后，请把 `@` 后面的部分填入 `user_type`，没有则留空（删掉默认的）
|
||||
|
||||
## :anchor: Docker / Kubernetes
|
||||
|
||||
镜像：`mmx233/bitsrunlogin-go:latest`
|
||||
|
||||
支持 linux/amd64、linux/386、linux/arm64、linux/arm/v7 架构（windows 的 WSL2 版 docker 也算 Linux）
|
||||
|
||||
直接使用：
|
||||
|
||||
配置文件挂载至 `/data/Config.yaml`，若需更改配置文件类型，可以使用 --entrypoint 覆写启动参数
|
||||
|
||||
```shell
|
||||
docker run path_to_config:/data/Config.yaml mmx233/bitsrunlogin-go:latest
|
||||
```
|
||||
|
||||
## :jigsaw: 作为module使用
|
||||
自行构建：
|
||||
|
||||
**\*本项目使用了AGPL V3 License，请酌情引用**
|
||||
如果需要在其他系统或架构使用，可能需要更改构建层与底层镜像，目前使用的 alpine 并不支持 linux 之外的系统
|
||||
|
||||
```shell
|
||||
git clone https://github.com/Mmx233/BitSrunLoginGo.git
|
||||
cd BitSrunLoginGo
|
||||
docker build . --file Dockerfile --tag mmx233/bitsrunlogin-go:latest
|
||||
```
|
||||
|
||||
## :jigsaw: 作为 module 使用
|
||||
|
||||
**\*本项目使用了 AGPL V3 许可证，请酌情引用**
|
||||
|
||||
示例：
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ func readConfig() error {
|
||||
Timeout: 5,
|
||||
},
|
||||
Daemon: srunModels.Daemon{
|
||||
Path: ".autoLogin",
|
||||
Path: ".BitSrun",
|
||||
},
|
||||
Guardian: srunModels.Guardian{
|
||||
Duration: 300,
|
||||
|
||||
Reference in New Issue
Block a user