docs: 更新 readme

This commit is contained in:
Mmx233
2023-01-14 20:13:49 +08:00
parent 63d8719485
commit e87e1f4c52

View File

@@ -70,7 +70,7 @@ settings:
## :bow_and_arrow: DDNS ## :bow_and_arrow: DDNS
`ddns.enable` 设为 `true`将在登录成功时设置指定域名的解析地址ipv4A 记录) `ddns.enable` 设为 `true` 后,将在登录成功时以及守护模式下首次启动已在线时设置指定域名的解析地址ipv4A 记录)
支持的 Provider 及其设置(将额外配置添加到配置文件 DDNS 配置内): 支持的 Provider 及其设置(将额外配置添加到配置文件 DDNS 配置内):
@@ -80,6 +80,8 @@ settings:
| cloudflare | `zone` 区域 ID<br/>`token` API 令牌 | | cloudflare | `zone` 区域 ID<br/>`token` API 令牌 |
| dnspod | `secret_id`<br/>`secret_key` | | dnspod | `secret_id`<br/>`secret_key` |
需要注意的是,应该避免在多网卡模式下使用 ddns如有需要可以每个网卡创建一个配置文件单独进行登录
## :anchor: Docker / Kubernetes ## :anchor: Docker / Kubernetes
镜像:`mmx233/bitsrunlogin-go:latest` 镜像:`mmx233/bitsrunlogin-go:latest`
@@ -156,25 +158,25 @@ import (
) )
func main() { func main() {
//具体用法请查看struct注释 //具体用法请查看struct注释
conf:=&BitSrun.Conf{ conf:=&BitSrun.Conf{
Https: false, Https: false,
Client: nil, Client: nil,
LoginInfo: BitSrun.LoginInfo{ LoginInfo: BitSrun.LoginInfo{
Form: &BitSrun.LoginForm{ Form: &BitSrun.LoginForm{
Domain: "", Domain: "",
UserName: "", UserName: "",
UserType: "", UserType: "",
PassWord: "", PassWord: "",
}, },
Meta: &BitSrun.LoginMeta{ Meta: &BitSrun.LoginMeta{
N: "", N: "",
Type: "", Type: "",
Acid: "", Acid: "",
Enc: "", Enc: "",
}, },
}, },
} }
online, clientIP, e := BitSrun.LoginStatus(conf) online, clientIP, e := BitSrun.LoginStatus(conf)
if e!=nil { if e!=nil {