Biến cấu hình máy chủ
Trang này dành cho người vận hành dịch vụ. Trang nêu các nhóm biến, và liệt kê riêng những biến đã đổi theo mô hình tổ chức. Các giá trị còn lại là bí mật hoặc tùy từng môi trường. Các biến cho email, Google, GitHub App, secret SSO và token dịch vụ nằm ở Tham chiếu tự cài.
Tara (TARA_*)
Tổ chức và role cơ sở dữ liệu. Các biến này mới hoặc đã đổi theo mô hình Organization. Giá trị chỉ là ví dụ.
| Biến | Mặc định | Ý nghĩa |
|---|---|---|
TARA_SINGLE_ORG | trống | Slug của tổ chức duy nhất trong bản tự cài, ví dụ acme. Khi đã đặt, việc tạo tổ chức bị tắt, và ánh xạ nhóm GitLab, OIDC (cùng thành viên TARA_GITHUB_ORG) vào tổ chức này. Để trống là chế độ nhiều tổ chức dùng chung. Xem Tự cài một tổ chức |
TARA_ENV | development | production khiến API và worker không khởi động nếu role cơ sở dữ liệu là superuser hoặc có BYPASSRLS. Giá trị khác chỉ ghi cảnh báo |
TARA_DATABASE_URL | PostgreSQL local | Kết nối của API và worker. Ở production dùng role tara_app, ví dụ postgres://tara_app:<mật-khẩu>@db.example.com:5432/tara |
TARA_MIGRATE_DATABASE_URL | TARA_DATABASE_URL | Kết nối bằng chủ cơ sở dữ liệu, chỉ tara-admin migrate dùng. Đừng đưa biến này vào môi trường của API và worker |
TARA_APP_DB_PASSWORD | trống | Mật khẩu của role tara_app. Khi đã đặt, tara-admin migrate up tạo hoặc cập nhật role ở mỗi lần chạy và cấp quyền trên mọi bảng |
TARA_GITHUB_ORG | trống | Đã đổi. Biến này không còn chặn đăng nhập. Đăng nhập GitHub mở cho mọi người. Khi có TARA_SINGLE_ORG, thành viên của tổ chức GitHub này vào tổ chức với vai trò member. Không có TARA_SINGLE_ORG thì biến bị bỏ qua và Tara ghi cảnh báo |
TARA_GITLAB_PROVIDERS, TARA_OIDC_PROVIDERS | trống | Đã đổi. Chỉ dùng để dựng nguồn đăng nhập ban đầu của tổ chức đầu tiên. Trong groups, giá trị giờ là vai trò trong tổ chức (admin, member hoặc viewer). Mã trung tâm cũ vẫn đọc được và tính là member, kèm cảnh báo. Phần tử có "connectOnly": true chỉ dùng để kết nối group GitLab của tổ chức (không là nguồn đăng nhập và groups được để trống); redirect URI OAuth của nó là <TARA_PUBLIC_URL>/auth/gitlab-connect/callback. Xem Chuẩn bị GitHub và GitLab |
TARA_GRAFANA_VIEWER_ROLES | owner,admin | Các vai trò trong tổ chức, ngoài viewer, mà Tara đưa vào org Grafana theo từng tổ chức. Chỉ dành cho người vận hành. Xem Grafana cho người vận hành |
Trung tâm đã được thay bằng tổ chức. Những gì không còn áp dụng: mã trung tâm trong ánh xạ groups, và việc đặt TARA_GITHUB_ORG để cho phép người dùng đăng nhập bằng GitHub.
Các nhóm biến.
| Nhóm | Dùng cho |
|---|---|
TARA_DATABASE_*, TARA_S3_*, TARA_ARTIFACT_* | PostgreSQL, kho gói S3 hoặc tương đương |
TARA_PUBLIC_*, TARA_PORTAL_*, TARA_MARKETPLACE_* | Địa chỉ công khai, Portal, tên marketplace |
TARA_OAUTH_*, TARA_OIDC_*, TARA_GITHUB_*, TARA_GITLAB_*, TARA_SCM_* | Đăng nhập và kết nối GitHub, GitLab |
TARA_SIGNING_* | Khóa ký số, lấy từ tệp hoặc KMS |
TARA_NOTIFY_* | Plugin thông báo, ghim tên@version:sha256, bí mật theo từng kit |
TARA_RYOMA_PUBLIC_URL | Địa chỉ máy khách (Phillip) gửi telemetry tới, công bố ở GET /v1/client-config; /install.sh, ph tara login và ph setup ghi nó vào cấu hình Phillip. Mặc định lấy TARA_RYOMA_URL; đặt khi Tara gọi Ryoma qua địa chỉ nội bộ (như http://ryoma-api:8090) còn máy khách dùng địa chỉ công khai |
TARA_RYOMA_URL, TARA_DELEGATION_KEY | Nơi Tara đọc số liệu Ryoma, và khóa (ngẫu nhiên từ 32 ký tự, chỉ tara-api giữ) ký token chỉ đọc ngắn hạn Tara gửi thay cho từng người dùng |
TARA_GRAFANA_*, TARA_BANDUM_* | Nối với Grafana, Bandum để hiển thị |
TARA_EMBEDDING_* | Embedding cho Knowledge base (tùy chọn) |
TARA_REVIEW_*, TARA_YARA_*, TARA_MALWARE_*, TARA_CLAUDE_BIN | Kiểm tra bài gửi: quét mã độc và chạy claude plugin validate |
TARA_KEYS, TARA_PLUGIN_*, TARA_NODE_* | Khóa tin cậy và sandbox chạy plugin |
Ryoma (RYOMA_*)
| Nhóm | Dùng cho |
|---|---|
RYOMA_DATABASE_*, RYOMA_CLICKHOUSE_*, RYOMA_RAW_TTL | PostgreSQL, kho phân tích ClickHouse, thời gian giữ dữ liệu thô |
RYOMA_OTLP_*, RYOMA_COLLECTOR_* | Cổng nhận telemetry và Collector |
RYOMA_TARA_*, RYOMA_AUTH_* | Xác thực token Tara |
RYOMA_SCM_*, RYOMA_WEBHOOK_*, RYOMA_PLUGIN_* | Đồng bộ task bằng kit SCM, webhook |
RYOMA_NOTIFY_*, RYOMA_DIGEST_*, RYOMA_GUARDRAILS_*, RYOMA_HEALTH_*, RYOMA_RISK_* | Thông báo, bản tin tuần, cảnh báo Guardrails, ngưỡng sức khỏe dự án |
RYOMA_LEADER_*, RYOMA_BACKGROUND | Chạy nhiều bản sao ryoma-api |
Mới ở Ryoma.
| Biến | Mặc định | Ý nghĩa |
|---|---|---|
RYOMA_TARA_SCM_TOKEN | RYOMA_TARA_TOKEN | Token Tara mà Ryoma dùng để xin token GitHub chỉ đọc, sống ngắn, theo installation GitHub App của tổ chức. Cần scope scm |
RYOMA_SCM_GITLAB_PLUGIN | trống | name@version:sha256 của kit-scm-gitlab, hoặc một thư mục local. Cho Ryoma đọc repo GitLab (khai bằng URL) của tổ chức có kết nối GitLab, bằng token do Tara cấp. Cần RYOMA_SCM_PLUGIN và RYOMA_TARA_SCM_TOKEN |
RYOMA_SCM_SERVER_TOKEN_ORGS | trống | Không dùng nữa. Slug các tổ chức (cách nhau bằng dấu phẩy) được dùng token SCM chỉ đọc riêng của máy chủ (RYOMA_SCM_TOKEN). Chỉ còn là đường lùi cho bản cài một tổ chức hoặc GitLab, và tổ chức có GitHub App không bao giờ dùng. Helm: config.scmServerTokenOrgs |
Bandum (BANDUM_*)
Phillip tự cấu hình Bandum local nên bạn hiếm khi đặt tay. Các biến chính gồm BANDUM_DATABASE_URL, BANDUM_SCM_PLUGIN, BANDUM_SCM_TOKEN, BANDUM_TARA_URL, BANDUM_TARA_KEYS, BANDUM_ORG và BANDUM_TIMEZONE. Với bản dùng GitHub App, BANDUM_TARA_SCM_TOKEN (mặc định BANDUM_TARA_TOKEN) là token Tara có scope scm, còn BANDUM_SCM_SERVER_TOKEN_ORGS không dùng nữa, giống Ryoma. Để đọc repo GitLab của tổ chức có kết nối GitLab, đặt thêm BANDUM_SCM_GITLAB_PLUGIN (name@version) cùng BANDUM_SCM_GITLAB_PLUGIN_SHA256, hoặc BANDUM_SCM_GITLAB_PLUGIN_DIR cho bản local. Host lấy từ kết nối.
BANDUM_ORG là biến mới. Đó là slug của tổ chức mà một Bandum online phục vụ, chỉ gồm [a-z0-9-], ví dụ acme. Ngoài gói chính thức (aiforge), Bandum chỉ nạp gói trong kho riêng của tổ chức đó, và tên plugin có thể kèm tổ chức, như acme/kit-x@1.0.0:<sha256>. Để trống thì chỉ nạp gói chính thức. Gói cộng đồng luôn bị từ chối. Bandum local đọc tổ chức hiện tại từ cấu hình của Phillip nên không cần biến này.
Đã bỏ: BANDUM_GITHUB_CLIENT_ID, BANDUM_GITHUB_CLIENT_SECRET và BANDUM_GITHUB_ORG không còn được dùng. Web Bandum đăng nhập qua Tara, và Bandum ghi cảnh báo nếu bạn vẫn đặt chúng.
Không đặt bí mật vào repo
Biến chứa token, mật khẩu hoặc khóa phải nằm trong biến môi trường, kho bí mật hoặc hệ thống quản lý bí mật của tổ chức. Đừng đưa chúng vào file bạn commit.
Các biến PHILLIP_* trên máy người dùng nằm ở trang Biến cấu hình.