screego1.12.0 中文文档

# 服务器的外部 IP。

# 如果使用双栈设置，请同时定义 IPv4 和 IPv6，用逗号分隔。

# 在你想要托管 Screego 的服务器上执行以下命令，以查找你的外部 IP。

# curl 'https://api.ipify.org'

# 示例：

# SCREEGO_EXTERNAL_IP=192.168.178.2,2a01:c22:a87c:e500:2d8:61ff:fec7:f92a

#

# 如果服务器没有静态 IP，可以通过域名获取：

# SCREEGO_EXTERNAL_IP=dns:app.screego.net

# 你也可以指定使用的 DNS 服务器：

# SCREEGO_EXTERNAL_IP=dns:app.screego.net@9.9.9.9:53

SCREEGO_EXTERNAL_IP=

# 一个应当唯一的密钥，用于 cookie 认证。

SCREEGO_SECRET=

# 是否为 HTTP 请求启用 TLS。Screego 需要 TLS，

# 你必须启用此设置或通过反向代理提供 TLS。

SCREEGO_SERVER_TLS=false

# TLS 证书文件（仅在启用 TLS 时需要）

SCREEGO_TLS_CERT_FILE=

# TLS 密钥文件（仅在启用 TLS 时需要）

SCREEGO_TLS_KEY_FILE=

# HTTP 服务器监听的地址。

# 格式：

# - host:port

# 示例：127.0.0.1:5050

# - Unix 套接字（必须以 unix: 前缀）

# 示例：unix:/my/file/path.socket

SCREEGO_SERVER_ADDRESS=0.0.0.0:5050

# TURN 服务器监听的地址。

SCREEGO_TURN_ADDRESS=0.0.0.0:3478

# 限制 TURN 用于数据中继的端口范围。

# 格式：min:max

# 示例：

# 50000:55000

SCREEGO_TURN_PORT_RANGE=

# 如果设置，Screego 将不会启动内置 TURN 服务器，而是使用外部 TURN 服务器。

# 如果使用双栈设置，请同时定义 IPv4 和 IPv6，用逗号分隔。

# 在托管 TURN 服务器的服务器上执行以下命令

# 以查找你的外部 IP。

# curl 'https://api.ipify.org'

# 示例：

# SCREEGO_TURN_EXTERNAL_IP=192.168.178.2,2a01:c22:a87c:e500:2d8:61ff:fec7:f92a

#

# 如果 TURN 服务器没有静态 IP，可以通过域名获取：

# SCREEGO_TURN_EXTERNAL_IP=dns:turn.screego.net

# 你也可以指定使用的 DNS 服务器：

# SCREEGO_TURN_EXTERNAL_IP=dns:turn.screego.net@9.9.9.9:53

SCREEGO_TURN_EXTERNAL_IP=

# 外部 TURN 服务器监听的端口。

SCREEGO_TURN_EXTERNAL_PORT=3478

# 外部 TURN 服务器的认证密钥。

SCREEGO_TURN_EXTERNAL_SECRET=

# 拒绝/禁止特定 CIDR 内的对等端，以防止 TURN 服务器用户

# 访问通过 TURN 服务器可达但无法通过互联网访问的机器，

# 适用于服务器位于 NAT 后的情况。

#

# 禁止内部 IP 地址：https://en.wikipedia.org/wiki/Reserved_IP_addresses

# SCREEGO_TURN_DENY_PEERS=0.0.0.0/8,10.0.0.0/8,100.64.0.0/10,127.0.0.1/8,169.254.0.0/16,172.16.0.0/12,192.0.0.0/24,192.0.2.0/24,192.88.99.0/24,192.168.0.0/16,198.18.0.0/15,198.51.100.0/24,203.0.113.0/24,224.0.0.0/4,239.0.0.0/8,255.255.255.255/32,::/128,::1/128,64:ff9b:1::/48,100::/64,2001::/32,2002::/16,fc00::/7,fe80::/10

#

# 默认拒绝本地地址。

SCREEGO_TURN_DENY_PEERS=0.0.0.0/8,127.0.0.1/8,::/128,::1/128,fe80::/10

# 是否信任反向代理头。

# Screego 使用 IP 白名单进行 TURN 连接认证。

# 当位于代理后时，IP 永远是代理服务器的 IP。

# 若要仍允许白名单，需要启用此设置，

# 并由反向代理设置 X-Real-Ip 头。

SCREEGO_TRUST_PROXY_HEADERS=false

# 定义何时需要用户登录

# 可选值：

# all：始终要求用户登录

# turn：仅在 TURN 连接时要求用户登录

# none：从不要求用户登录

SCREEGO_AUTH_MODE=turn

# 定义允许访问 Screego 的源（HTTP + WebSocket）

# 默认值适用于大多数情况。

# 示例值： https://screego.net,https://sub.gotify.net

SCREEGO_CORS_ALLOWED_ORIGINS=

# 定义用户文件的位置。

# 文件格式：

# user1:bcrypt_password_hash

# user2:bcrypt_password_hash

#

# 示例：

# user1:$2a$12$WEfYCnWGk0PDzbATLTNiTuoZ7e/43v6DM/h7arOnPU6qEtFG.kZQy

#

# 用户密码对可以通过以下命令创建：

# screego hash --name "user1" --pass "your password"

SCREEGO_USERS_FILE=

# 定义用户会话有效期（秒）。

# 0 = 会话在浏览器关闭后失效

SCREEGO_SESSION_TIMEOUT_SECONDS=0

# 定义房间创建对话框中复选框的默认值，

# 用于选择房主离开时是否关闭房间

SCREEGO_CLOSE_ROOM_WHEN_OWNER_LEAVES=true

# 日志等级（可选值：debug, info, warn, error）

SCREEGO_LOG_LEVEL=info

# 是否在 /metrics 暴露 Prometheus 接口。该接口

# 需要 users 文件中的用户进行基本认证。

SCREEGO_PROMETHEUS=false