rustio.env.example

# RustIO 环境变量配置模板
#
# 用途:完整的 RustIO 运行时环境变量参考,按功能分类列出全部可调项与默认值。
# - 一键部署(install.sh install / install.sh systemd)只写入必需的少数几项到 /etc/rustio/env；
#   本文件涵盖更完整的高级配置,可按需追加到 /etc/rustio/env 或部署脚本的环境变量中。
# - 所有项均为可选,不设置则使用注释中标注的默认值。
# - 修改 /etc/rustio/env 后需 `systemctl restart rustio` 生效。

# ============================================================
# 核心:监听地址 / 数据目录 / 前端静态资源
# ============================================================
# 监听地址(单端口:控制台 + S3 + Admin API 共用)
# RUSTIO_ADDR=0.0.0.0:9000

# 数据目录
# RUSTIO_DATA_DIR=/opt/rustio/data

# 源码启动时的前端静态资源目录
# RUSTIO_CONSOLE_DIST=./web/console/dist

# 日志级别(tracing-subscriber EnvFilter 语法)
# RUST_LOG=rustio=debug,rustio_admin=debug,tower_http=info

# ============================================================
# 安全:生产环境必须显式设置(否则拒绝启动,除非 RUSTIO_ALLOW_INSECURE=1)
# ============================================================
# JWT 签名密钥,建议: openssl rand -base64 48
# RUSTIO_JWT_SECRET=

# 管理控制台账号(默认 admin / rustio-admin)
# RUSTIO_CONSOLE_USER=admin
# RUSTIO_CONSOLE_PASSWORD=

# S3 Root 账号(默认 rustioadmin / rustioadmin;同时兼容 MINIO_ROOT_USER/PASSWORD)
# RUSTIO_ROOT_USER=rustioadmin
# RUSTIO_ROOT_PASSWORD=

# 跨节点内部 RPC 令牌,集群部署必须为所有节点显式设置相同值(未设置则每进程随机生成)
# RUSTIO_INTERNAL_TOKEN=

# 跳过启动安全校验(仅本地开发使用,生产环境禁止)
# RUSTIO_ALLOW_INSECURE=0

# 控制台跨域来源(不设置则回退 http://localhost:9000)
# RUSTIO_CORS_ORIGIN=https://rustio.example.com

# ============================================================
# 存储:纠删码 / 数据盘 / 元数据索引
# ============================================================
# EC 数据分片数(默认 4)/ 校验分片数(默认 1)
# RUSTIO_EC_DATA_SHARDS=4
# RUSTIO_EC_PARITY_SHARDS=1

# 数据盘列表(逗号/分号/空白分隔;少于 5 个则回退到 <data_dir>/.rustio_disks/disk-{0..4})
# RUSTIO_DATA_DISKS=/mnt/disk1,/mnt/disk2,/mnt/disk3,/mnt/disk4,/mnt/disk5
# RUSTIO_EC_DISKS=            # 与 RUSTIO_DATA_DISKS 等价的别名

# LIST 元数据索引模式:未设置或非 1 时使用 redb 有序索引(推荐);设为 1 回退 walk-fs(异常恢复用)
# RUSTIO_LIST_WALK_FS=0

# 元数据 LRU 缓存容量(条数,默认 100000)
# RUSTIO_META_CACHE_CAP=100000

# SSE 加密模式(默认 SSE-KMS)
# RUSTIO_SSE_MODE=SSE-KMS

# ============================================================
# 集群 / Raft(仅多节点部署需要)
# ============================================================
# 本节点集群标识
# RUSTIO_CLUSTER_NODE_ID=1
# RUSTIO_CLUSTER_NODE_NAME=node-1
# RUSTIO_CLUSTER_NODE_ADDR=10.0.1.1:9000
# RUSTIO_CLUSTER_NODE_ZONE=zone-a
# RUSTIO_CLUSTER_SEEDS=10.0.1.1:9000,10.0.1.2:9000
# RUSTIO_GROUP_ID=default

# 元数据 raft 网络(集群模式需启用)
# RUSTIO_METADATA_RAFT_NETWORK_ENABLED=false
# RUSTIO_METADATA_RAFT_NODE_ID=meta-1
# RUSTIO_METADATA_RAFT_PEERS=meta-1=10.0.1.1:9000,meta-2=10.0.1.2:9000

# peer 健康探测间隔 ms(默认 15000)/ 对象元数据 healing 扫描间隔 ms(默认 60000,仅集群)
# RUSTIO_PEER_PROBE_INTERVAL_MS=15000
# RUSTIO_META_HEAL_INTERVAL_MS=60000

# ============================================================
# 复制(同城/异地)
# ============================================================
# 启用远程复制 worker(默认 false)
# RUSTIO_REPLICATION_REMOTE_ENABLED=false

# worker 轮询间隔 ms(默认 250,范围 50-5000)/ 租约 ms(默认约为间隔*12,范围 100-300000)
# RUSTIO_REPLICATION_WORKER_INTERVAL_MS=250
# RUSTIO_REPLICATION_LEASE_MS=

# worker 并发度(默认 1,范围 1-32)
# RUSTIO_REPLICATION_WORKER_CONCURRENCY=1

# 重试退避基数 ms(默认 500)/ 上限 ms(默认 30000)/ 最大重试次数(默认 8)
# RUSTIO_REPLICATION_RETRY_BASE_MS=500
# RUSTIO_REPLICATION_RETRY_MAX_MS=30000
# RUSTIO_REPLICATION_MAX_ATTEMPTS=8

# 复制积压告警:轮询间隔 ms(默认 1000)/ 抑制窗口秒(默认 60)
# RUSTIO_REPLICATION_BACKLOG_ALERT_INTERVAL_MS=1000
# RUSTIO_REPLICATION_BACKLOG_ALERT_SUPPRESS_SECONDS=60
# 失败阈值(默认 50)/ 死信阈值(默认 5)/ 积压过久阈值秒(默认 900)
# RUSTIO_REPLICATION_BACKLOG_ALERT_FAILED_THRESHOLD=50
# RUSTIO_REPLICATION_BACKLOG_ALERT_DEAD_LETTER_THRESHOLD=5
# RUSTIO_REPLICATION_BACKLOG_ALERT_PENDING_AGE_SECONDS=900

# ============================================================
# 存储治理:扫描 / 巡检 / 再平衡
# ============================================================
# 后台全量扫描间隔 ms(默认 1800000,即 30 分钟)
# RUSTIO_STORAGE_SCAN_INTERVAL_MS=1800000

# heal worker 轮询间隔 ms(默认 1000)/ heal 任务最大重试次数(默认 3,范围 1-10)
# RUSTIO_STORAGE_HEAL_INTERVAL_MS=1000
# RUSTIO_STORAGE_JOB_MAX_ATTEMPTS=3

# heal/rebuild 并发上限(默认 1,范围 1-16)
# RUSTIO_STORAGE_HEAL_MAX_RUNNING=1

# 再平衡并发度(默认 2)/ 节流 ms(默认 0,不节流)
# RUSTIO_REBALANCE_CONCURRENCY=2
# RUSTIO_REBALANCE_THROTTLE_MS=0

# ============================================================
# 托管异步任务(批处理 / 生命周期等)
# ============================================================
# worker 轮询间隔 ms(默认 200)/ 租约 ms(默认 5000)/ 最大重试次数(默认 3)
# RUSTIO_ASYNC_JOB_WORKER_INTERVAL_MS=200
# RUSTIO_ASYNC_JOB_LEASE_MS=5000
# RUSTIO_ASYNC_JOB_MAX_ATTEMPTS=3

# 生命周期规则执行间隔 ms
# RUSTIO_LIFECYCLE_INTERVAL_MS=

# ============================================================
# 告警:规则评估 / 投递队列 / 各通道
# ============================================================
# 规则评估间隔 ms(默认 15000)
# RUSTIO_ALERT_RULE_EVAL_INTERVAL_MS=15000

# 投递队列轮询间隔 ms(默认 500)/ 租约 ms(默认约为间隔*8)/ 最大重试次数(默认 5)
# RUSTIO_ALERT_DELIVERY_INTERVAL_MS=500
# RUSTIO_ALERT_DELIVERY_LEASE_MS=
# RUSTIO_ALERT_DELIVERY_MAX_ATTEMPTS=5

# 投递重试退避基数 ms(默认 500)/ 上限 ms(默认 30000)/ HTTP 超时 ms(默认 5000)
# RUSTIO_ALERT_DELIVERY_RETRY_BASE_MS=500
# RUSTIO_ALERT_DELIVERY_RETRY_MAX_MS=30000
# RUSTIO_ALERT_DELIVERY_HTTP_TIMEOUT_MS=5000

# SMTP 通道
# RUSTIO_ALERT_SMTP_SERVER=
# RUSTIO_ALERT_SMTP_FROM=rustio-alert@localhost
# RUSTIO_ALERT_SMTP_USERNAME=
# RUSTIO_ALERT_SMTP_PASSWORD=
# RUSTIO_ALERT_SMTP_STARTTLS=false
# RUSTIO_ALERT_SMTP_TLS=false

# NATS 通道
# RUSTIO_ALERT_NATS_SUBJECT=rustio.alerts
# RUSTIO_ALERT_NATS_USERNAME=
# RUSTIO_ALERT_NATS_PASSWORD=
# RUSTIO_ALERT_NATS_TOKEN=
# RUSTIO_ALERT_NATS_TLS=false

# Redis 通道
# RUSTIO_ALERT_REDIS_CHANNEL=rustio.alerts
# RUSTIO_ALERT_REDIS_USERNAME=
# RUSTIO_ALERT_REDIS_PASSWORD=
# RUSTIO_ALERT_REDIS_TLS=false

# 各通道共用 TLS CA 证书文件路径
# RUSTIO_ALERT_TLS_CA_FILE=

# ============================================================
# 审计 / 内存维护(无自然上界集合的裁剪策略)
# ============================================================
# 审计事件内存保留上限(默认 2048,范围 100-100000)
# RUSTIO_AUDIT_MAX_EVENTS=2048

# 对象热度提示表上限(默认 100000)/ 告警历史上限(默认 5000)/ 告警投递终态保留数(默认 2000)
# RUSTIO_OBJECT_HEAT_MAX_ENTRIES=100000
# RUSTIO_ALERT_HISTORY_MAX_ENTRIES=5000
# RUSTIO_ALERT_DELIVERY_TERMINAL_RETAIN=2000

# 是否启用内存裁剪(默认 true)
# RUSTIO_MEMORY_TRIM_ENABLED=true

# 裁剪检查间隔秒(默认 300)/ 空闲多久后裁剪秒(默认 43200,即 12 小时)
# RUSTIO_MEMORY_TRIM_INTERVAL_SECONDS=300
# RUSTIO_MEMORY_TRIM_IDLE_SECONDS=43200

# 强制裁剪最小间隔秒(默认 7200)/ 周期裁剪间隔秒(默认 600)
# RUSTIO_MEMORY_TRIM_FORCE_INTERVAL_SECONDS=7200
# RUSTIO_MEMORY_TRIM_PERIODIC_SECONDS=600

# 触发强制裁剪的 RSS 阈值 MB(默认 128)
# RUSTIO_MEMORY_TRIM_RSS_THRESHOLD_MB=128

# ============================================================
# KMS(密钥管理服务对接)
# ============================================================
# RUSTIO_KMS_ENDPOINT=
# RUSTIO_KMS_PROVIDER=
# RUSTIO_KMS_API_KEY=
# RUSTIO_KMS_TOKEN=
# RUSTIO_KMS_EXTERNAL_ENABLED=false

# ============================================================
# OIDC 单点登录
# ============================================================
# RUSTIO_OIDC_ENABLED=false
# RUSTIO_OIDC_ISSUER=
# RUSTIO_OIDC_DISCOVERY_URL=
# RUSTIO_OIDC_JWKS_URL=
# RUSTIO_OIDC_CLIENT_ID=
# RUSTIO_OIDC_ALLOWED_ALGS=RS256
# RUSTIO_OIDC_USERNAME_CLAIM=sub
# RUSTIO_OIDC_ROLE_CLAIM=
# RUSTIO_OIDC_GROUPS_CLAIM=groups
# RUSTIO_OIDC_GROUP_ROLE_MAP=
# RUSTIO_OIDC_DEFAULT_ROLE=viewer

# ============================================================
# LDAP 认证
# ============================================================
# RUSTIO_LDAP_ENABLED=false
# RUSTIO_LDAP_URL=
# RUSTIO_LDAP_BIND_DN=
# RUSTIO_LDAP_USER_BASE_DN=
# RUSTIO_LDAP_USER_FILTER=
# RUSTIO_LDAP_GROUP_BASE_DN=
# RUSTIO_LDAP_GROUP_FILTER=
# RUSTIO_LDAP_GROUP_ATTRIBUTE=
# RUSTIO_LDAP_GROUP_NAME_ATTRIBUTE=
# RUSTIO_LDAP_GROUP_ROLE_MAP=
# RUSTIO_LDAP_DEFAULT_ROLE=viewer

# ============================================================
# Docker 启动(scripts/start.sh / docker-compose.yml)
# ============================================================
# RUSTIO_HOST_PORT=9000
# RUSTIO_CONTAINER_PORT=9000
# RUSTIO_DATA_DIR_HOST=./data
# RUSTIO_DATA_DIR_CONTAINER=/app/data
# RUSTIO_CONTAINER_NAME=rustio
# RUSTIO_IMAGE_NAME=rustio-rustio
# RUSTIO_RESTART_POLICY=unless-stopped
# RUSTIO_DOCKERFILE=Dockerfile.rustio

# ============================================================
# 源码构建(scripts/start-source.sh)
# ============================================================
# RUSTIO_AUTO_MIRROR=1
# RUSTIO_SKIP_WEB_BUILD=0
# RUSTIO_FORCE_WEB_BUILD=0
# RUSTIO_USE_DOCKER_NODE_BUILD=0
# RUSTIO_RUST_TOOLCHAIN=stable
# RUSTIO_NPM_REGISTRY=

# ============================================================
# 部署管理脚本(install.sh install / upgrade / uninstall / cluster / expand)自身用的变量
# 这些不是服务运行时变量,只在执行脚本时通过环境变量传参
# ============================================================
# RUSTIO_VERSION=            # 指定安装/升级版本,默认 latest
# RUSTIO_GH_MIRROR=          # 国内镜像代理前缀,如 https://ghproxy.com/
# RUSTIO_INSTALL_DIR=/usr/local/bin
# RUSTIO_PORT=9000
# RUSTIO_USER=root
# SKIP_SYSTEMD=0