Documentation
¶
Index ¶
Constants ¶
View Source
const ( SitenameKey = "sitename" DescriptionKey = "description" CorsOriginCheckEnabledKey = "cors_origin_check_enabled" CorsAllowedOriginsKey = "cors_allowed_origins" WsOriginCheckEnabledKey = "ws_origin_check_enabled" WsAllowedOriginsKey = "ws_allowed_origins" ThemeKey = "theme" PrivateSiteKey = "private_site" APIKeyKey = "api_key" AutoDiscoveryKeyKey = "auto_discovery_key" SendIPAddrToGuestKey = "send_ip_addr_to_guest" VisitorAuditEnabledKey = "visitor_audit_enabled" SSRFProtectionEnabledKey = "ssrf_protection_enabled" GeoIPEnabledKey = "geo_ip_enabled" GeoIPProviderKey = "geo_ip_provider" OAuthEnabledKey = "o_auth_enabled" OAuthProviderKey = "o_auth_provider" DisablePasswordLoginKey = "disable_password_login" CustomHeadKey = "custom_head" CustomBodyKey = "custom_body" NotificationEnabledKey = "notification_enabled" NotificationMethodKey = "notification_method" NotificationTemplateKey = "notification_template" ExpireNotificationEnabledKey = "expire_notification_enabled" ExpireNotificationLeadDaysKey = "expire_notification_lead_days" LoginNotificationKey = "login_notification" TrafficLimitPercentageKey = "traffic_limit_percentage" ThemeMarketSourcesKey = "theme_market_sources" PluginMarketSourcesKey = "plugin_market_sources" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Settings ¶
type Settings struct {
ID uint `json:"id,omitempty"` // 1
Sitename string `json:"sitename" default:"Sonar"` // 站点名称,默认 "Sonar"
Description string `json:"description" default:"A simple server monitor tool."` // 站点描述
CorsOriginCheckEnabled bool `json:"cors_origin_check_enabled" default:"true"` // 是否启用 API CORS 跨域请求校验,默认 true
CorsAllowedOrigins string `json:"cors_allowed_origins" default:""` // API 跨域允许列表
WsOriginCheckEnabled bool `json:"ws_origin_check_enabled" default:"true"` // 是否校验 WebSocket Origin
WsAllowedOrigins string `json:"ws_allowed_origins" default:""` // WebSocket Origin 允许列表
Theme string `json:"theme" default:"default"` // 主题名称,默认 'default'
PrivateSite bool `json:"private_site" default:"false"` // 是否为私有站点,默认 false
APIKey string `json:"api_key" default:""` // API 密钥,默认空字符串
AutoDiscoveryKey string `json:"auto_discovery_key" default:""` // 自动发现密钥
SendIPAddrToGuest bool `json:"send_ip_addr_to_guest" default:"false"` // 是否向访客页面发送 IP 地址,默认 false
VisitorAuditEnabled bool `json:"visitor_audit_enabled" default:"false"` // 是否允许公开访客事件写入审计日志,默认 false
SSRFProtectionEnabled bool `json:"ssrf_protection_enabled" default:"false"` // 是否启用 SSRF 防护,默认关闭
// GeoIP 配置
GeoIPEnabled bool `json:"geo_ip_enabled" default:"true"`
GeoIPProvider string `json:"geo_ip_provider" default:"ipinfo"` // empty, mmdb, ip-api, geojs
// OAuth 配置
OAuthEnabled bool `json:"o_auth_enabled" default:"false"`
OAuthProvider string `json:"o_auth_provider" default:"github"`
DisablePasswordLogin bool `json:"disable_password_login" default:"false"`
// 自定义美化
CustomHead string `json:"custom_head" default:""`
CustomBody string `json:"custom_body" default:""`
// 通知
NotificationEnabled bool `json:"notification_enabled" default:"true"` // 通知总开关
NotificationMethod string `json:"notification_method" default:"none"`
NotificationTemplate string `` /* 143-byte string literal not displayed */
ExpireNotificationEnabled bool `json:"expire_notification_enabled" default:"true"` // 是否启用过期通知
ExpireNotificationLeadDays int `json:"expire_notification_lead_days" default:"7"` // 过期前多少天通知,默认7天
LoginNotification bool `json:"login_notification" default:"true"` // 登录通知
TrafficLimitPercentage float64 `json:"traffic_limit_percentage" default:"80.00"` // 流量限制百分比,默认80.00%
}
Click to show internal directories.
Click to hide internal directories.