文档目录
配置参考
大部分日常设置都在控制台的 设置 里改，保存在数据库中。这一页介绍启动时读取的配置：配置文件 config.yaml 和环境变量，修改后需要重启 Rerinku View 才生效。
配置文件与优先级
- 首次启动时，Rerinku View 会在当前工作目录生成
config.yaml（权限 0600）。注意是启动时所在的目录，不是程序文件所在的目录。 - 用环境变量
RERINKU_CONFIG可以指定别的路径，这时文件必须已经存在。 - 优先级：环境变量 > 配置文件 > 程序内置默认值。值为空的环境变量视为没有设置。
- 配置文件里出现不认识的键时，Rerinku View 会拒绝启动，避免拼错的设置被悄悄忽略。
- 配置文件里的相对路径，按工作目录解析。
首次生成的配置文件：
http:
addr: "0.0.0.0:8080"
# 数据库、密钥和录像都保存在这个目录。
data_dir: "./data"
gb28181:
enabled: true
addr: ":5060"
server_id: "34020000002000000001"
realm: "3402000000"
password: "change-me" # 接入设备前请修改
media: "auto"
rerinku_device:
enabled: true
broker_addr: "0.0.0.0:1883"生成的配置文件会对局域网开放三个端口：控制台 8080、设备接入用的 MQTT 1883，以及国标 SIP 5060。国标默认是打开的，密码是
change-me：不用国标的话把gb28181.enabled设为false，要用就先改掉密码。
控制台里改过的录像容量、保留天数等设置保存在数据库里，以数据库为准；配置文件里的值只作为初始值。设置 → 国标 页面会把修改写回 config.yaml 的 gb28181 段；如果同时设了 GB28181_* 环境变量，重启后环境变量会覆盖页面上的修改。
监听与访问控制
| 环境变量 | 配置文件 | 默认值 | 说明 |
|---|---|---|---|
HTTP_ADDR |
http.addr |
0.0.0.0:8080（生成的配置文件） |
控制台、接口、实时画面信令、回放、设备注册和推流共用这一个端口。程序内置默认是 127.0.0.1:8080 |
REQUIRE_API_AUTH |
— | 按监听地址推导 | 只监听本机回环时不要求令牌，监听其他地址时要求。设 1 或 0 可以强制 |
ALLOWED_ORIGINS |
server.allowed_origins |
空 | 列出的网站来源按同源对待：没设访问密码时，这些网站的网页不带令牌也能调用接口。请只填你信任的地址 |
TRUST_PROXY_HEADERS |
server.trust_proxy_headers |
false |
在反向代理后面时设为 true：采信 X-Forwarded-* 等请求头来识别真实客户端地址和 HTTPS |
SHUTDOWN_TIMEOUT |
server.shutdown_timeout |
10s |
停止时等待请求结束的最长时间 |
RESET_ACCESS_PASSWORD |
— | 空 | 设为 1 启动一次即清除访问密码和所有浏览器登录，之后务必去掉 |
DEMO_MODE |
demo_mode |
false |
演示模式：访客只能看、不能改，密码、内网地址、访客 IP 一概不显示 |
访问密码本身在控制台 设置 → 会话 里设置，见远程访问。
数据与录像
| 环境变量 | 配置文件 | 默认值 | 说明 |
|---|---|---|---|
| — | data_dir |
./data |
数据目录。数据库是 <data_dir>/rerinkuview.db，录像在 <data_dir>/recordings |
DATABASE_PATH |
— | ./data/rerinkuview.db |
只用环境变量时的数据库路径（注意文件名和用配置文件时不同） |
RECORDINGS_PATH |
— | ./data/recordings |
只用环境变量时的录像目录 |
SECRET_KEY_PATH |
— | 与数据库同目录的 secret.key |
加密密钥，见备份 |
RECORDINGS_MAX_BYTES |
recordings.max_bytes |
100 GiB | 录像总量上限，0 表示不限 |
RECORDINGS_MIN_FREE_BYTES |
recordings.min_free_bytes |
2 GiB | 磁盘至少保留的空间，0 表示不限 |
RECORDINGS_RETENTION_DAYS |
recordings.retention_days |
0（不按天数删除） |
录像最多保留多少天，0–3650 |
RECORDINGS_FILE_DURATION |
recordings.file_duration |
10m |
每个录像文件的时长，1 分钟到 4 小时 |
AUDIT_RETENTION |
audit.retention |
2160h（90 天） |
审计日志保留时长，0 表示不清理 |
MODELS_PATH |
— | 与数据库同目录的 models/ |
AI 识别模型 |
FACES_PATH |
— | 与数据库同目录的 faces/ |
人脸库照片 |
RERINKU_BIN_DIR |
bin_dir |
~/.rerinku/bin |
内置的 FFmpeg、识别组件等在启动时解压到这里 |
LOG_LEVEL |
log.level |
info |
控制台日志输出多少：info 只输出启动地址、停止、告警和错误等关键信息；排查问题时改成 debug 输出全部细节；也可以是 warn、error |
录像容量和清理规则见录像与回放。
实时画面（WebRTC）
| 环境变量 | 配置文件 | 默认值 | 说明 |
|---|---|---|---|
STREAM_STUN_SERVERS |
stream.stun_servers |
空 | STUN 服务器，没有内置默认值。开启快速连接后改用 Rerinku Cloud 下发的 TURN，这一项不再生效 |
STREAM_ICE_LISTEN |
— | 空 | 默认每个连接用一个随机 UDP 端口。设为如 :8189 后，所有连接共用这一个 UDP 端口，方便配置防火墙 |
STREAM_ICE_CANDIDATES |
— | 空 | 对外宣告的 IP，适用于云主机或一对一 NAT |
STREAM_ICE_INTERFACES、STREAM_ICE_IPS |
— | 空 | 只用这些网卡或 IP；默认已跳过 docker、veth、tailscale 等虚拟网卡 |
STREAM_ICE_NETWORKS |
— | udp4,tcp4 |
默认只用 IPv4 |
设备接入
用 Rerinku View SDK 的设备，以及 Rerinku Cam 手机 App，通过 HTTP 注册、通过内置的 MQTT 服务接收命令。
| 环境变量 | 配置文件 | 默认值 | 说明 |
|---|---|---|---|
DEVICE_GATEWAY_ENABLED |
rerinku_device.enabled |
true |
关掉后只能接入 ONVIF、RTSP、国标和 USB 摄像头 |
DEVICE_BROKER_ADDR |
rerinku_device.broker_addr |
0.0.0.0:1883（生成的配置文件） |
内置 MQTT 服务的监听地址。设备登录要带设备令牌，只能使用自己的主题 |
DEVICE_PUBLIC_URL |
rerinku_device.public_url |
由 HTTP_ADDR 推导 |
下发给设备的 Rerinku View 地址，必须是设备访问得到的局域网 IP 或域名 |
DEVICE_MQTT_BROKER |
rerinku_device.public_mqtt_broker |
tcp://<本机 IP>:<端口> |
下发给设备的 MQTT 地址 |
DEVICE_KEY |
rerinku_device.key |
空（任何设备都能注册） | 设置后，设备注册时必须带 secret = base64(HMAC-SHA256(DEVICE_KEY, sn)) |
自动推导的地址用的是本机的出站 IP；机器有多块网卡，或换了 IP，请显式设置 public_url 和 public_mqtt_broker。
国标（GB28181）
| 环境变量 | 配置文件 | 默认值 | 说明 |
|---|---|---|---|
GB28181_ENABLED |
gb28181.enabled |
true（生成的配置文件） |
是否启用国标 SIP 服务。程序内置默认是关闭 |
GB28181_ADDR |
gb28181.addr |
:5060 |
SIP 监听地址，UDP 与 TCP 同时监听 |
GB28181_SERVER_ID |
gb28181.server_id |
34020000002000000001 |
平台的 SIP 服务器编号，设备端要填这个 |
GB28181_REALM |
gb28181.realm |
服务器编号的前 10 位 | SIP 域 |
GB28181_PASSWORD |
gb28181.password |
change-me（生成的配置文件） |
设备注册的密码，留空表示不鉴权 |
GB28181_MEDIA |
gb28181.media |
auto |
媒体传输：auto、udp 或 tcp |
快速连接与 Rerinku Cloud
| 环境变量 | 配置文件 | 默认值 | 说明 |
|---|---|---|---|
CLOUD_API_URL |
cloud.api_url |
https://rerinku.com |
Rerinku Cloud 的地址 |
CLOUD_REPORT |
cloud.report |
true |
每 10 分钟向 Rerinku Cloud 上报一次安装信息（实例 ID、版本、操作系统和硬件概况，不含设备和录像），false 关闭 |
快速连接的凭据在控制台开启时获得，保存在数据库中，见远程访问。
视频解码与调试
| 环境变量 | 配置文件 | 默认值 | 说明 |
|---|---|---|---|
VIDEO_HW_DECODE |
video.hw_decode |
true |
设为 false 强制只用软件解码，见 AI 识别 |
APP_ENV |
app_env |
development |
为 development 时会在 127.0.0.1:6060 开启调试接口（pprof）。正式运行建议设为 production |
DEBUG_ADDR |
debug.addr |
127.0.0.1:6060 |
调试接口地址，只允许本机回环地址 |
端口
| 端口 | 用途 | 需要放行吗 |
|---|---|---|
| 8080/TCP | 控制台、接口、实时画面信令、回放、设备注册与推流 | 需要 |
| 1883/TCP | 内置 MQTT 服务（设备接入） | 有用 Rerinku View SDK 的设备或 Rerinku Cam 时 |
| 5060/UDP、TCP | 国标 SIP | 用国标时 |
| 国标媒体 | 每路一个随机端口 | 用国标时 |
| WebRTC/UDP | 默认用系统随机端口 | 建议设 STREAM_ICE_LISTEN=:8189 后只放行这一个 |
| 127.0.0.1:6060 | 调试接口，只在本机 | 不需要 |
ONVIF 自动发现依赖局域网组播（3702 端口），主机防火墙可能拦截发现的回包，见接入摄像头。