私有部署配置
私有部署的配置是 deploy/private.env 里的环境变量。configure.py 用离线包里的示例文件生成它,并填上新的随机密钥,然后你们再填自己的端点和登录配置。这些都不适用于云服务,云服务的配置由我们负责。
密钥的值只放在服务器的环境里,别的地方一律不放。应用里的设置只接受凭据引用。
模式与地址
| 变量 | 取值 |
|---|---|
YI_MODE | production |
YI_DEPLOYMENT | private |
YI_OFFLINE | 完全不能访问公网的部署填 true。要求 YI_DEPLOYMENT=private |
YI_PUBLIC_URL | 用户访问的 HTTPS 地址,例如 https://agent.corp.internal。生产模式要求 HTTPS |
YI_ALLOWED_HOSTS | API 接受的主机名,逗号分隔 |
YI_DATABASE_URL | PostgreSQL 连接地址。生产模式要求 PostgreSQL。configure.py 会填好自带数据库的密码 |
POSTGRES_DB、POSTGRES_USER、POSTGRES_PASSWORD | 自带的数据库。密码自动生成 |
YI_SESSION_SECRET、YI_TOKEN_SECRET | 两个不同的随机值,至少 32 个字符,由 configure.py 生成。不要在别处复用 |
登录
在身份服务上为 Yi Code 注册一个客户端,回调地址是 YI_PUBLIC_URL 后面加 /auth/callback,例如 https://agent.corp.internal/auth/callback。
| 变量 | 取值 |
|---|---|
YI_OIDC_ISSUER | 身份服务的 issuer 地址。生产模式必填 |
YI_OIDC_CLIENT_ID | 客户端 ID。默认 yi-agent |
YI_OIDC_CLIENT_SECRET | 客户端密钥,机密客户端才需要 |
YI_PRIVATE_ORG_ID | 这个部署里所有人所属的组织,例如 customer |
YI_OIDC_ROLE_CLAIM | 携带角色的 claim。默认 org_role。取值为 owner、admin 或 member,其他值都按成员处理 |
YI_OIDC_ORG_ROLE | 可选。给所有用户同一个角色,适合只有一个团队的身份服务。优先用签名的角色 claim,也不要给所有内部用户 admin |
YI_OIDC_ORG_CLAIM | 示例文件里默认 org_id。私有部署的组织由 YI_PRIVATE_ORG_ID 决定,不使用这个 claim |
YI_OIDC_AUTHORIZATION_MODE | userinfo(默认)会定期到身份服务的 userinfo 端点复核成员和角色。login_only 只在登录时检查 |
YI_AUTHORIZATION_RECHECK_SECONDS | 复核间隔,5 到 300 秒。默认 60 |
YI_ORG_ENROLLMENT | 保持 invite |
连接
| 变量 | 取值 |
|---|---|
YI_GIT_HOSTS | 项目可以使用的 Git 主机,逗号分隔。默认 github.com |
YI_CONNECTOR_HOSTS | 模型、知识库和 MCP 端点允许使用的主机,逗号分隔。离线部署里每个端点都必须在这个列表里 |
YI_GATEWAY_URL | YI_PUBLIC_URL 后面加 /v1/gateway。执行主机把模型调用和工具调用发到这里 |
执行
| 变量 | 取值 |
|---|---|
YI_RUNTIME_IMAGE | 运行镜像,按 digest 固定。install.py 会把它设成离线包自带的镜像 |
YI_MAX_CONCURRENCY | 整个部署同时运行的轮次数,1 到 10。默认 10 |
YI_MAX_RUN_SECONDS | 一轮的时长上限,单位秒。默认 3600。在这个上限之内,Ask 最多 900 秒,Code 最多 3600 秒 |
执行主机登记为 static 类型的执行池,见私有与离线部署。
产物存储
| 变量 | 取值 |
|---|---|
YI_ARTIFACT_BACKEND | local(默认)把产物放在控制面的卷上。s3 使用 S3 兼容对象存储,API 跑多个副本时需要 |
YI_ARTIFACT_ENDPOINT | 对象存储地址,配合 s3 |
YI_ARTIFACT_BUCKET | 存储桶,配合 s3 |
YI_ARTIFACT_PREFIX | 存储桶里的键前缀。默认 yi-agent |
保持原样
DO_NOT_TRACK=1 和 LITELLM_LOCAL_MODEL_COST_MAP=True 用来防止自带的库发送遥测或从公网拉数据,请保持原样。
凭据引用
「凭据引用(可选)」「Git 凭据引用」这类字段填的是 API 服务器上一个环境变量的名字,不是密钥本身。名字必须以你们组织的前缀开头,前缀显示在「设置」页最下方「你的凭据前缀:」后面,例如 YI_CREDENTIAL_…_GIT。值由部署管理员设在服务器的环境里。数据库只保存名字,应用也从不显示值。
服务器上没有值的引用,保存时会被拒绝。
模型
管理员在「设置」的「模型端点」里添加模型:
- 「OpenAI 兼容端点 /v1」和「Deployment 名称」,主机要在
YI_CONNECTOR_HOSTS里。 - 「输出 token 参数」:选端点要求的那个,
max_completion_tokens(默认)或max_tokens,很多内部兼容端点用后者。 - 凭据引用,内部无鉴权的端点可以留空。
- 输入、缓存输入和输出的费率,单位是每百万 token 多少美元。轮次按这个费率扣费。
「检查端点」会发一次真实的工具调用,检查回复里有没有整数形式的 token 用量。生产模式下,模型通过检查后才会出现在选项里。
HTTP API
API 是给 Web 应用用的。它靠浏览器会话认证,修改类请求要求同源。每个部署在 /openapi.json 提供描述各个接口的 OpenAPI 文档。