Opptrix/compose.env.example at main · Travisun/Opptrix · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# Copy to compose.env and pass with: docker compose --env-file compose.env up -d
# Or rename to .env next to docker-compose.yml (Compose auto-loads `.env` for interpolation).
# Do NOT commit real API keys.

# ── Bind address (required for Docker) ──
STOCK_RESEARCH_HOST=0.0.0.0
# HTTP 默认关闭。反代需要明文 upstream 时设 OPPTRIX_ENABLE_HTTP=1 并自行映射 8711
OPPTRIX_ENABLE_HTTP=0
STOCK_RESEARCH_PORT=8711
# 容器内 HTTPS（自签名，生产默认入口）；设为 0 可关闭（Docker 下禁止）
OPPTRIX_HTTPS_PORT=8712
# 宿主机发布端口（compose ports 插值；改后需 recreate 容器）
# OPPTRIX_HOST_HTTP_PORT=8711
OPPTRIX_HOST_HTTPS_PORT=8712
# 浏览器默认走 HTTPS 自签时保持 1；若仅用宿主机 Nginx 终结 TLS 且 upstream 明文，可按文档调整
OPPTRIX_AUTH_COOKIE_SECURE=1
SERVE_UI=1

# ── Persistent paths inside the container (unified home) ──
OPPTRIX_HOME=/opptrix
OPPTRIX_DATA_DIR=/opptrix/private
OPPTRIX_AGENT_WORKSPACE_DIR=/opptrix/workspace
OPPTRIX_MOUNTS_DIR=/opptrix/mounts
OPPTRIX_MODELS_DIR=/opptrix/models
OPPTRIX_SYSTEM_DIR=/opptrix/system
OPPTRIX_DOCKER=1
# Agent：off=无 SRT、自由编程 + 双用户 DAC（默认）；full=工作区 grant 围栏
# OPPTRIX_AGENT_SANDBOX=off
# 固定身份（与镜像 useradd 一致；entrypoint 会再解析）
# OPPTRIX_AGENT_USER=opptrix-agent
# OPPTRIX_AGENT_UID=10001
# OPPTRIX_AGENT_GID=10001
OPPTRIX_SEED_ROOT=/app
# Entrypoint sets UI_DIST_PATH from system/boot after seed; image default is fine:
UI_DIST_PATH=/app/client-ui/dist
# OPPTRIX_ONCE=1
# OPPTRIX_SUPERVISOR_MAX_RETRIES=10

# ── Core model dirs (with-models default layout) ──
OPPTRIX_LLM_DIR=/opptrix/models/llms
OPPTRIX_E5_BUNDLED_DIR=/opptrix/models/llms/multilingual-e5-small
OPPTRIX_RAPIDOCR_MODEL_DIR=/opptrix/models/llms/rapidocr-ppocrv4-mobile
OPPTRIX_RAPIDOCR_BUNDLED_DIR=/opptrix/models/llms/rapidocr-ppocrv4-mobile
OPPTRIX_SENSEVOICE_BUNDLED_DIR=/opptrix/models/sensevoice
OPPTRIX_WITH_MODELS=1
# Default: models via onboarding (no entrypoint download). Legacy first-boot fetch:
# OPPTRIX_FETCH_MODELS_ON_START=1
# OPPTRIX_SKIP_MODEL_FETCH=1
# OPPTRIX_FORCE_MODEL_FETCH=1

# ── Auth / reverse proxy ──
# Unclaimed instance: only loopback/local clients can use the API.
# After you create an account in the UI, remote access requires login.
# OPPTRIX_TRUSTED_PROXIES=10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
# OPPTRIX_TRUSTED_LOCAL_CIDRS=
# OPPTRIX_AUTH_COOKIE_SECURE=1
# OPPTRIX_AUTH_SAFE_MODE=1

# ── Optional LLM bootstrap (also configurable in Settings) ──
# LLM_PROVIDER=DeepSeek
# LLM_MODEL=deepseek-chat
# LLM_API_KEY=
# LLM_BASE_URL=https://api.deepseek.com

# ── Build mirrors（推荐用 CLI）──
#   npm i -g @opptrix/selfhost
#   # 或仓内: npm run build -w @opptrix/selfhost && npm link -w @opptrix/selfhost
#   opptrix init --mirror cn
#   opptrix up --mirror cn
# Linux 一键: ./scripts/bootstrap/linux.sh
# macOS/Windows: 自备 Docker+Node 后同上 npm 安装
# Compose 插值也可写入同目录 `.env`：
# OPPTRIX_DOCKER_IMAGE_PREFIX=docker.1ms.run/library/  # CN: 1ms Hub library/（勿用裸 docker.1ms.run/ 或 …/amd64/）
# OPPTRIX_NPM_REGISTRY=https://mirrors.huaweicloud.com/repository/npm/  # CN 默认华为；留空=官方；不可用时脚本会回退官方
# OPPTRIX_APT_MIRROR=mirrors.aliyun.com
# OPPTRIX_MIRROR_AUTO_BUILD=1   # probe CN vs foreign at docker build
OPPTRIX_MIRROR_AUTO=1         # runtime pip/npm mirror auto (entrypoint probes on start)
# 语音/媒体解码：Docker 默认 Debian apt ffmpeg（FFMPEG_PATH=/usr/bin/ffmpeg）；桌面版仍用打包 ffmpeg-static
# FFMPEG_PATH=/usr/bin/ffmpeg
# Playwright Chromium（Docker 镜像预装 /opt/opptrix/playwright-browsers）
# PLAYWRIGHT_BROWSERS_PATH=/opt/opptrix/playwright-browsers
# 热更新 runtime 包下载线路（检测仍走 update.opptrix.org；大包按线路 failover）
# OPPTRIX_UPDATE_MIRROR=auto   # auto | cn | foreign（与 OPPTRIX_MIRROR 同义）
# OPPTRIX_FORCE_CN=1
# OPPTRIX_FORCE_FOREIGN=1
# 国外 / GitHub CI：NODE_IMAGE_PREFIX 留空（官方 Docker Hub）；见 ci-selfhost-release / publish-selfhost-image。
# OPPTRIX_NODE_VERSION=24.11.1   # managed Node pin (see scripts/lib/ci-pins.env)
# CI uses ubuntu-24.04 LTS runners + node:24.11.1-bookworm (scripts/lib/ci-pins.env)

# ── Model download mirrors (optional) ──
# 模型下载源顺序（默认国内优先）：modelscope → hf-mirror → huggingface
# OPPTRIX_MODEL_SOURCE_ORDER=modelscope,hf-mirror,huggingface
# HY-MT：ModelScope 组织名与 HF 不同
# OPPTRIX_HY_MT_MODELSCOPE_REPO=Tencent-Hunyuan/HY-MT1.5-1.8B-GGUF
# OPPTRIX_HY_MT_HF_REPO=tencent/HY-MT1.5-1.8B-GGUF
# OPPTRIX_MODELSCOPE_BASE=https://modelscope.cn
# OPPTRIX_HF_MIRROR=https://hf-mirror.com
# CI 海外优先：OPPTRIX_CI_FOREIGN_MIRRORS=1
# OPPTRIX_CI_FOREIGN_MIRRORS=0
# HF_TOKEN=
# OPPTRIX_RAPIDOCR_DIRECT_URL_PREFIX=