Tham chiếu tự cài
Trang này liệt kê các biến bật tính năng đăng nhập và GitHub của một Tara tự cài, cùng Ryoma và Bandum. Các nhóm biến chung nằm ở Biến cấu hình. Mọi giá trị dưới đây chỉ là giá trị giữ chỗ. Bí mật thật hãy để ở nơi lưu bí mật, đừng để trong git.
Với Docker Compose, bạn đặt giá trị vào tệp môi trường của bản cài (bản mẫu có đủ, đang để chú thích). Với Helm, secret vào Secret của chart, phần còn lại vào config hoặc extraEnv (Cài bằng Helm).
Đăng nhập
| Biến | Mặc định | Ý nghĩa |
|---|---|---|
TARA_PUBLIC_URL | http://localhost:8080 | Địa chỉ công khai. Callback OAuth, GitHub App và SSO đều bắt đầu từ đây |
TARA_GOOGLE_CLIENT_ID, TARA_GOOGLE_CLIENT_SECRET | trống | Đặt cả hai thì bật đăng nhập Google. Đăng ký callback <TARA_PUBLIC_URL>/auth/google/callback. Chỉ tài khoản có email đã xác minh mới đăng nhập được |
TARA_SMTP_URL | trống | Máy chủ thư cho lời mời và link đăng nhập: smtp://user:pass@host:587 (STARTTLS nếu có) hoặc smtps://user:pass@host:465 |
TARA_MAIL_FROM | trống | Người gửi, ví dụ PhillipCLI <no-reply@example.com> |
Không có TARA_SMTP_URL thì thư chỉ được ghi vào log. Ở production (TARA_ENV=production), đăng nhập bằng email khi đó không dùng được, vì không ai nhận được link. Xem Các cách đăng nhập.
GitHub App
Đặt đủ sáu biến hoặc không đặt biến nào. Đặt thiếu là lỗi khi khởi động. Cách nhanh để có giá trị là Đăng ký GitHub App.
| Biến | Mặc định | Ý nghĩa |
|---|---|---|
TARA_GITHUB_APP_ID | trống | ID dạng số của app |
TARA_GITHUB_APP_SLUG | trống | Tên ngắn của app trong địa chỉ GitHub |
TARA_GITHUB_APP_PRIVATE_KEY_FILE | trống | Đường dẫn tới private key (PEM) của app, đọc khi khởi động. Để ngoài image. Với bộ Compose một máy, đặt PEM vào thư mục secrets cạnh docker-compose.yml (hoặc TARA_SECRETS_DIR), chủ sở hữu là uid 10001, quyền 400, rồi đặt /run/secrets/tara/github-app.pem. Với Helm, dùng githubApp.privateKey.existingSecret |
TARA_GITHUB_APP_WEBHOOK_SECRET | trống | Ký webhook, tối thiểu 16 ký tự |
TARA_GITHUB_APP_CLIENT_ID, TARA_GITHUB_APP_CLIENT_SECRET | trống | Thông tin OAuth của app, dùng để kiểm tra ai đang cài |
TARA_GITHUB_API_URL | https://api.github.com | Địa chỉ API GitHub. Đổi khi dùng GitHub Enterprise Server |
TARA_GITHUB_SYNC_INTERVAL | 1h | Tần suất Tara làm mới repo và thành viên. 0 là tắt đồng bộ định kỳ |
TARA_GITHUB_IMPORT_TOKEN | trống | Tùy chọn. Nâng hạn mức của GitHub khi nhập repo công khai. Token này chỉ đọc dữ liệu công khai |
Secret cho SSO của tổ chức
Mỗi tổ chức lưu client secret SSO ở dạng mã hóa. Bạn chọn một nguồn khóa:
| Biến | Ý nghĩa |
|---|---|
TARA_SECRET_KEY | Khóa cục bộ: 32 byte ngẫu nhiên, viết thành 64 ký tự hex hoặc base64 (openssl rand -base64 32) |
TARA_SECRETS_VAULT_ADDR, TARA_SECRETS_VAULT_KEY, TARA_SECRETS_VAULT_TOKEN | Dùng KMS thay thế: khóa Transit của Vault hoặc OpenBao loại aes256-gcm96. Phải đặt cả ba |
TARA_SECRETS_VAULT_MOUNT, TARA_SECRETS_VAULT_NAMESPACE | Tùy chọn. Mount của Transit (mặc định transit) và namespace |
Đừng đặt TARA_SECRET_KEY cùng các biến Vault. Không có cái nào thì tổ chức không cài được SSO. Hãy sao lưu khóa: mất khóa là các secret đã lưu không đọc được nữa, admin phải nhập lại. Ở production, issuer phải là địa chỉ https công khai, và Tara từ chối nối tới địa chỉ riêng hoặc nội bộ. Xem SSO của tổ chức.
Token cho Ryoma và Bandum
Ryoma và Bandum đọc issue và PR trên GitHub qua một tài khoản dịch vụ của Tara. Tài khoản này xin Tara token GitHub chỉ đọc, sống ngắn.
| Biến | Ý nghĩa |
|---|---|
RYOMA_TARA_SCM_TOKEN | Token Tara mà Ryoma dùng cho việc này. Không đặt thì Ryoma dùng RYOMA_TARA_TOKEN |
BANDUM_TARA_SCM_TOKEN | Tương tự cho Bandum. Không đặt thì dùng BANDUM_TARA_TOKEN |
Token của tài khoản dịch vụ cần scope scm. Bạn đặt scope trên máy chủ (tên tài khoản và tên token theo bản cài của bạn):
tara-admin token-scopes ryoma-svc <token-name> read,scm
tara-admin token-scopes bandum-svc <token-name> read,delegate,scmĐể token không gắn tổ chức thì nó dùng được cho mọi tổ chức có installation, hoặc gắn vào một tổ chức để giới hạn trong tổ chức đó.
Không dùng nữa: RYOMA_SCM_SERVER_TOKEN_ORGS, BANDUM_SCM_SERVER_TOKEN_ORGS
Hai biến này từng liệt kê các tổ chức được dùng một token chỉ đọc chung của cả máy chủ (RYOMA_SCM_TOKEN, BANDUM_SCM_TOKEN). Nay mặc định trống, và chỉ còn là đường lùi cho bản cài một tổ chức hoặc GitLab, nơi không có GitHub App. Tổ chức đã có GitHub App không bao giờ dùng chúng. Helm (chart Ryoma): config.scmServerTokenOrgs, mặc định trống.