Documentation
¶
Overview ¶
Package runner 启动 m-ui 数据面:渲染配置 → 拉起内嵌 sing-box → 应用用户限速/设备数策略。
Index ¶
- Constants
- Variables
- func ResetPassword(dbPath, user, pw string) (string, string, error)
- func Run(dbPath string) error
- func SetPanelStarter(f func(*Runner) error)
- func SetSettings(dbPath string, kv map[string]string) error
- type BackupFile
- type CertTargets
- type CertView
- type ExtRefreshResult
- type IssueRequest
- type ReloadStatus
- type Runner
- func (r *Runner) ApplyLimits()
- func (r *Runner) BackupDir() string
- func (r *Runner) BackupFilePath(name string) (string, error)
- func (r *Runner) CancelIssue() bool
- func (r *Runner) CertBriefs() []model.CertBrief
- func (r *Runner) CertInfo() acme.CertInfo
- func (r *Runner) CertPaths() []string
- func (r *Runner) CertSource() string
- func (r *Runner) CertStatus() map[string]interface{}
- func (r *Runner) Certs() []CertView
- func (r *Runner) CheckUpstream(up model.Upstream) (ok bool, delayMs int, method, errStr string)
- func (r *Runner) ConnCounts() map[string]int
- func (r *Runner) CoreRunning() bool
- func (r *Runner) CreateBackupFile() (BackupFile, error)
- func (r *Runner) DB() *gorm.DB
- func (r *Runner) DBPath() string
- func (r *Runner) DataDir() string
- func (r *Runner) DataPlaneCert() (string, string)
- func (r *Runner) DeleteCert(name string) error
- func (r *Runner) GroupState() map[string]hub.GroupState
- func (r *Runner) Hub() *hub.Hub
- func (r *Runner) InboundCount() int
- func (r *Runner) InspectBackup(src string) (backup.Summary, error)
- func (r *Runner) IsNode() bool
- func (r *Runner) IssueCert(req IssueRequest) error
- func (r *Runner) KickShare(name string) int
- func (r *Runner) KickUser(name string) int
- func (r *Runner) KickUserAll(name string) hub.KickResult
- func (r *Runner) KickUserLocal(name string) (closed, sessions int)
- func (r *Runner) ListBackups() []BackupFile
- func (r *Runner) LocalNodeId() uint
- func (r *Runner) LocalNodeName() string
- func (r *Runner) Monitor() *monitor.Monitor
- func (r *Runner) NodeCert() render.NodeCert
- func (r *Runner) Notifier() *notify.Notifier
- func (r *Runner) OnlineIPLines() map[string]map[string][]string
- func (r *Runner) OnlineIPs(user string) []string
- func (r *Runner) OnlineIPsAll() map[string][]string
- func (r *Runner) Onlines() jobs.Onlines
- func (r *Runner) PublicHost() string
- func (r *Runner) Reach() *reach.Service
- func (r *Runner) RecentConns(limit int) []hub.RecentConn
- func (r *Runner) RefreshExt(id uint) (ExtRefreshResult, error)
- func (r *Runner) ReloadAll() (err error)
- func (r *Runner) ReloadAllForce() (err error)
- func (r *Runner) ReloadStatus() ReloadStatus
- func (r *Runner) ReloadUpstreams() (err error)
- func (r *Runner) ReloadUsers() (err error)
- func (r *Runner) ReloadUsersSecure() (err error)
- func (r *Runner) RestartSub() error
- func (r *Runner) RestorePending() bool
- func (r *Runner) RulesNow()
- func (r *Runner) ScheduleRestart(delay time.Duration)
- func (r *Runner) SelfSign(hosts []string, targets CertTargets) error
- func (r *Runner) SetExternalIPs(m map[string][]string)
- func (r *Runner) SetLogEnabled(bool)
- func (r *Runner) SetSetting(key, val string) error
- func (r *Runner) SetSettings(values map[string]string) error
- func (r *Runner) StageRestore(src string) (backup.Summary, error)
- func (r *Runner) Start() (err error)
- func (r *Runner) Stop()
- func (r *Runner) TestUpstream(name, testURL string) core.CheckOutboundResult
- func (r *Runner) UpstreamHealthLocal() []monitor.UpstreamHealth
- func (r *Runner) Uptime() uint32
- func (r *Runner) UseCert(name, target string) error
- func (r *Runner) UseExternalCert(certFile, keyFile string, targets CertTargets) error
- func (r *Runner) WriteBackup(w io.Writer) error
Constants ¶
const ( CertForLines = "lines" // 线路默认证书 CertForPanel = "panel" // 面板 HTTPS CertForSub = "sub" // 订阅 HTTPS )
证书的用途。
const SelfSignedName = "self-signed"
SelfSignedName 自签证书在库里的名字。每台机器只留一张,重新生成就覆盖。
Variables ¶
var Version = "dev"
Version 由 main 注入,写进备份 meta。
Functions ¶
func ResetPassword ¶
ResetPassword 重置管理员密码;user 为空 = 库里现有的管理员(改过用户名也认得),库里一个管理员都没有时才创建 admin; pw 为空则随机生成。返回实际重置的用户名与明文密码。 以前硬编码 "admin":管理员把用户名改掉之后,菜单里重置密码会凭空多出一个 admin 账号。
func SetPanelStarter ¶
SetPanelStarter 注册面板启动函数,在 Run 时随数据面一起拉起。
Types ¶
type BackupFile ¶
type CertTargets ¶ added in v0.7.16
type CertTargets struct {
Lines, Panel, Sub bool
}
CertTargets 新证书要顶替哪些用途;没勾的不动(以前没勾的会被清掉,签第二张证书把面板的 HTTPS 关了)。
type CertView ¶ added in v0.7.16
type CertView struct {
model.Cert
Info acme.CertInfo `json:"info"`
ForLines bool `json:"forLines"`
ForPanel bool `json:"forPanel"`
ForSub bool `json:"forSub"`
LineNames []string `json:"lineNames"` // 单独选了这张证书的线路
}
CertView 证书库的一行:库里记的 + 证书文件读出来的 + 正用在哪。
type ExtRefreshResult ¶
type ExtRefreshResult struct {
Links int `json:"links"`
Clash int `json:"clash"`
Error string `json:"error,omitempty"`
}
ExtRefreshResult 是一次外部订阅抓取的结果。
type IssueRequest ¶ added in v0.7.16
type IssueRequest struct {
Domain, Method string
Staging, AutoRenew bool
Targets CertTargets
// contains filtered or unexported fields
}
IssueRequest 一次签发:域名与验证方式,签好之后顶替哪些用途。
type ReloadStatus ¶ added in v0.5.0
type ReloadStatus struct {
At int64 `json:"at"`
Op string `json:"op"`
OK bool `json:"ok"`
Error string `json:"error,omitempty"`
}
ReloadStatus 最近一次数据面重载(启动、全量、热换出站、热更新用户)的结果。 重载都是保存之后异步做的,接口早已返回"已保存";失败只写日志的话操作者永远不知道线上还是旧配置。
type Runner ¶
type Runner struct {
// contains filtered or unexported fields
}
Runner 持有数据面运行所需的一切。
func (*Runner) ApplyLimits ¶ added in v0.6.0
func (r *Runner) ApplyLimits()
ApplyLimits 重新下发限速(规则状态变了、副机按到期时间解除规则限速时用)。读库失败交给后台重试:以前错误被吞掉, 状态已经落库、下一轮判定认为一致不再下发,这条限速在整个惩罚期都不生效,解除时则一直限着(审计 MB19)。
func (*Runner) BackupFilePath ¶
BackupFilePath 校验文件名并返回绝对路径(防路径穿越)。
func (*Runner) CancelIssue ¶ added in v0.7.16
CancelIssue 取消正在进行的签发:手动 DNS 填错了域名时,不用干等半小时。返回有没有东西可取消。
func (*Runner) CertBriefs ¶ added in v0.7.16
CertBriefs 这台服务器的证书清单,报给主机(线路编辑框、订阅 SNI 用)。
func (*Runner) CertSource ¶ added in v0.1.5
CertSource 证书来源:acme(Let's Encrypt 签发)/ selfsign(自签)/ external(服务器上已有)。
func (*Runner) CheckUpstream ¶
CheckUpstream 对单个上游做健康检查(面板手动测试与定时巡检共用)。 数据面运行时经该上游真实请求测试 URL;未运行时 TCP 类做端口探测,QUIC 类无法离线测试。
func (*Runner) CreateBackupFile ¶
func (r *Runner) CreateBackupFile() (BackupFile, error)
CreateBackupFile 在备份目录生成一个备份并按 backupKeep 轮转,返回文件名。
func (*Runner) DataPlaneCert ¶ added in v0.1.5
DataPlaneCert 当前线路入站(数据面)用的证书与私钥路径。
func (*Runner) DeleteCert ¶ added in v0.7.16
DeleteCert 从库里删掉一张证书。还在用的不让删;面板自己存的文件一并删,服务器上已有的证书只是不再记,原件不动。
func (*Runner) GroupState ¶ added in v0.4.13
func (r *Runner) GroupState() map[string]hub.GroupState
GroupState 各代理池在本机的状态(在线设备数、设备池满被拒次数),供 Hub 汇总给面板。
func (*Runner) InboundCount ¶ added in v0.5.0
InboundCount 数据面当前的入站数(健康检查用:线路都在库里,监听器却没起来就是不健康)。
func (*Runner) InspectBackup ¶
InspectBackup 检查一个备份文件。
func (*Runner) IssueCert ¶
func (r *Runner) IssueCert(req IssueRequest) error
IssueCert 发起一次签发(异步),进度经 CertStatus 查询。
func (*Runner) KickUser ¶
KickUser 断开某用户的全部连接,返回断开数。 KickUser 只断本机:连接 + 整条会话,再清掉 limiter 里他的在线 IP。返回断开的连接数。 停用 / 删除 / 重置链接这些路径用它就够了:快照 5 秒内推到副机,副机热换用户表时自己关掉被移除 / 换了凭据的会话。
func (*Runner) KickUserAll ¶ added in v0.6.9
func (r *Runner) KickUserAll(name string) hub.KickResult
KickUserAll 面板 / 代理面板 / 外部 API 的「踢下线」:本机 + 所有副机。 只有主机派发;副机上调用等于本机踢线(hub.KickUser 在副机上直接返回空)。
func (*Runner) KickUserLocal ¶ added in v0.6.9
KickUserLocal 本机踢线,返回 (断开的连接数, 关掉的会话数)。
func (*Runner) ListBackups ¶
func (r *Runner) ListBackups() []BackupFile
ListBackups 返回备份目录里的文件(新的在前)。
func (*Runner) LocalNodeId ¶ added in v0.4.22
LocalNodeId 本机在 nodes 表里的 id。
func (*Runner) LocalNodeName ¶ added in v0.4.22
LocalNodeName 本机在服务器列表里的名字(巡检告警里点名用)。
func (*Runner) OnlineIPLines ¶ added in v0.1.7
OnlineIPLines 本机上 用户 → 源 IP → 线路名。
func (*Runner) OnlineIPsAll ¶ added in v0.2.2
OnlineIPsAll 本机上 用户 → 活跃源 IP(一次锁拿全量,面板列表用)。
func (*Runner) PublicHost ¶
PublicHost 返回对外地址:订阅域名 → 面板域名 → 本机公网 IP。
func (*Runner) RecentConns ¶ added in v0.5.0
func (r *Runner) RecentConns(limit int) []hub.RecentConn
RecentConns 本机最近的入站连接(源 IP × 线路聚合),概览诊断卡与副机报告用。
func (*Runner) RefreshExt ¶
func (r *Runner) RefreshExt(id uint) (ExtRefreshResult, error)
RefreshExt 立即抓取一个外部订阅并更新缓存;单条链接类型只重新解析。
func (*Runner) ReloadAllForce ¶
ReloadAllForce 无条件重启数据面(证书文件内容变了但配置文本没变时用)。
func (*Runner) ReloadStatus ¶ added in v0.5.0
func (r *Runner) ReloadStatus() ReloadStatus
ReloadStatus 返回最近一次重载的结果(尚未重载过时 At 为 0)。
func (*Runner) ReloadUpstreams ¶
ReloadUpstreams 只增删改有变化的出站,不重启数据面,现有用户连接不受影响。 适用于上游增删改(线路与路由未变);同一份配置里的用户变化一并热更新。任一步失败则回退到全量重载。
func (*Runner) ReloadUsers ¶
ReloadUsers 只刷新用户相关状态:入站用户表就地热更新(不断开现有连接), 并重新下发限速/设备数策略。用于新增/禁用用户、改配额与限速等高频操作。
func (*Runner) ReloadUsersSecure ¶ added in v0.6.10
ReloadUsersSecure 用于撤销凭据等不能继续接受旧用户表的变更。 重载失败时停止数据面并保留重试标记,绝不回滚成已撤销的凭据。
func (*Runner) RestorePending ¶
RestorePending 报告是否有待应用的还原文件。
func (*Runner) RulesNow ¶ added in v0.6.0
func (r *Runner) RulesNow()
RulesNow 立刻判一轮限速规则(规则增删改后不用等下一轮统计),状态变了就重新下发限速; 快照里带着状态表,下一轮同步自然推给副机。
func (*Runner) ScheduleRestart ¶
ScheduleRestart 在短暂延迟后重启进程(还原备份、改端口后使用)。
func (*Runner) SelfSign ¶
func (r *Runner) SelfSign(hosts []string, targets CertTargets) error
SelfSign 生成自签证书(无域名 / 纯 IP 场景)。默认只给线路入站用: 自签证书不被系统信任,面板与订阅走 HTTPS 会让浏览器和客户端报错; 订阅链接会自动带"允许不安全",客户端打开该开关即可连上。
func (*Runner) SetExternalIPs ¶
SetExternalIPs 下发其他机器上在线的 IP 给本机限制器(跨机设备数)。
func (*Runner) SetLogEnabled ¶ added in v0.5.0
SetLogEnabled 面板"日志"页开关:立即生效,不重启数据面。
func (*Runner) SetSetting ¶
SetSetting 写入一个设置项(面板保存证书设置用)。
func (*Runner) SetSettings ¶ added in v0.6.10
SetSettings writes a related set of settings atomically.
func (*Runner) StageRestore ¶
StageRestore 把备份文件放到待还原位置,重启后生效。
func (*Runner) TestUpstream ¶
func (r *Runner) TestUpstream(name, testURL string) core.CheckOutboundResult
TestUpstream 通过运行中的数据面,经指定上游真实发一次 HTTP 请求,返回延迟或错误。 这是最可信的健康检查:连 WARP 本地代理是否真的通都能测出来。
func (*Runner) UpstreamHealthLocal ¶ added in v0.4.22
func (r *Runner) UpstreamHealthLocal() []monitor.UpstreamHealth
UpstreamHealthLocal 本机巡检结果(副机随报告上报给主机)。
func (*Runner) UseExternalCert ¶ added in v0.1.5
func (r *Runner) UseExternalCert(certFile, keyFile string, targets CertTargets) error
UseExternalCert 使用服务器上已有的证书(如 certbot / nginx / 商业证书):只记录路径,不复制文件, 证书续期后覆盖原文件即可,面板与订阅会自动换用(线路入站在下次重载时生效)。