Skip to content

Biến môi trường và cấu hình ​

Cortex được cấu hình ở bốn nơi: infra/.env trên server, phần thiết lập của hub trong dashboard, thư mục .cortex/ của từng project, và biến môi trường trên các máy chạy agent và worker.

Server: infra/.env ​

Chép infra/.env.example thành infra/.env rồi điền vào. docker compose đọc file này. Xem Tự dựng hub cho toàn bộ quá trình thiết lập.

Bắt buộc ​

BiếnÝ nghĩa
MANAGEMENT_PASSWORDKey cho management API của LLM proxy. Không có giá trị mặc định

Tùy chọn ​

BiếnMặc địnhÝ nghĩa
GITNEXUS_AUTH_TOKENtự sinhBearer token cho dịch vụ đồ thị code. Để trống thì được sinh một lần và chia sẻ với API qua một volume
DEFAULT_REPOkhông cóMột repo để index ngay lần khởi động đầu
GEMINI_API_KEYkhông cóCho embedding hoặc chat model của Gemini
PORT4000Cổng của cortex-api
DATABASE_PATH/app/data/cortex.dbFile SQLite bên trong container
EXTERNAL_MCP_URLkhông cóĐịa chỉ công khai mà agent kết nối tới (/mcp được nối thêm vào). Để trống thì dashboard hiển thị địa chỉ mà agent đầu tiên đã dùng, nếu không có thì địa chỉ local
EXTERNAL_API_URL, EXTERNAL_LLM_PROXY_URLkhông cóTương tự, cho các đường link trên Settings
BRANCH_RETENTION_DAYS14Xóa vector của một branch sau chừng ấy ngày không được index, hoặc khi branch đã merge hay bị xóa. Không bao giờ xóa branch mặc định. 0 là giữ tất cả
SESSION_IDLE_HOURS72Đánh dấu một phiên đang mở là expired sau chừng ấy giờ không có lời gọi tool. 0 = không bao giờ
CORTEX_LLMtheo Settingsoff: không bao giờ gọi chat model. on: bỏ qua công tắc trong Settings
MEMORY_LLMtheo Settingsoff: lưu bộ nhớ đúng như được viết, không trích xuất sự kiện
RECIPE_CAPTUREtheo Settingsoff: không tạo recipe từ các task và phiên đã xong
OLLAMA_MEMORY_LIMIT, OLLAMA_CPUS, OLLAMA_THREADS, QDRANT_MEMORY_LIMIT4G, 4, OLLAMA_CPUS, 2GGiới hạn tài nguyên
CORTEX_IMAGE_NAMESPACEghcr.io/lktiepNơi kéo image Cortex về

Embedding không bao giờ cần chat model. Có ba tính năng cần: trích xuất sự kiện cho bộ nhớ, ghi lại recipe và tự sửa kiến thức. Không có chat model nào được định tuyến thì ba tính năng này tắt.

Truy cập API ​

BiếnÝ nghĩa
API_AUTHrequired: /api chỉ trả lời loopback, MCP gateway, API key và, khi đặt đủ hai biến CF_ACCESS_*, trình duyệt đã qua Cloudflare Access. Không đặt hoặc off: ai gọi cũng trả lời
INTERNAL_API_SECRETDùng chung giữa cortex-api và cortex-mcp. Tạo bằng openssl rand -hex 32
CF_ACCESS_TEAM_DOMAIN, CF_ACCESS_AUDTeam domain của Cloudflare Access và audience tag của ứng dụng
API_BINDĐịa chỉ mở các cổng API. 127.0.0.1 giữ chúng trên chính host

WARNING

Dashboard không có đăng nhập riêng. Hãy đặt API_AUTH=required và đặt dashboard sau một access proxy trước khi cho truy cập từ bên ngoài. Xem Tự dựng hub.

Thiết lập của hub ​

Trang Settings trên dashboard chứa cấu hình riêng của hub: các endpoint, định tuyến LLM, MCP config để sao chép, tùy chọn thông báo và cách chạy worker. Nhà cung cấp LLM và các model dùng cho chat và embedding được đặt trong LLM Providers.

Conductor đọc các khóa sau từ bảng hub_config của hub:

KhóaMặc địnhÝ nghĩa
conductor.defaultFallback[{executor: "claude", model: "opus"}]Các tuyến được thử sau tuyến riêng của task
conductor.branchTemplatecx/{key}-{slug}Tên branch cho task không có branch
conductor.offlineReclaimMinutes30Số phút worker được phép offline trước khi task của nó bị lấy lại
conductor.leaseHours24Số giờ một task được chạy trước khi bị lấy lại
conductor.baseBranchbranch mặc định của project, nếu không thì mainNơi các branch của task bắt đầu

Chỉ conductor.defaultFallback được tạo khi hub khởi động lần đầu. Route của Settings chỉ cập nhật các khóa đã có, nên các khóa còn lại giữ giá trị mặc định trừ khi có ai thêm một dòng vào bảng.

Project: .cortex/ ​

FileAi ghiÝ nghĩa
project-profile.jsontrình cài đặt, một lầnCác stack và trình quản lý gói dò được (fingerprint), các bước kiểm tra cần chạy (verify), và mục worker tùy chọn
agent-identity.jsontrình cài đặtVai trò và capability của agent
.hooks-versiontrình cài đặtPhiên bản của các hook; trình cài đặt mới hơn sẽ tạo lại chúng
.session-state/hookCác marker mà gate đọc. Bị git bỏ qua

project-profile.json có schema_version là 2.0. Mục verify gồm pre_commit, full, auto_fix và max_retries. Trình cài đặt để nguyên hồ sơ đã có; muốn đổi thì sửa tay.

Máy chạy agent ​

BiếnDùng bởiÝ nghĩa
HUB_MCP_URL, HUB_API_KEYtrình cài đặt, hookMCP endpoint của hub và key. Xem Trình cài đặt
CORTEX_MCP_URLhookĐược ưu tiên hơn HUB_MCP_URL
CORTEX_NUDGE=off, CORTEX_NOTES=offhookTắt lời gợi ý tra cứu hoặc ghi chú theo file. Xem Hook

Máy chạy worker ​

Danh sách đầy đủ có ở biến môi trường của cw. Những biến hay được đặt nhất:

BiếnÝ nghĩa
CORTEX_HUB_URL, CORTEX_API_KEY, CORTEX_AGENT_IDHub, key và định danh của worker
CORTEX_SETUP_CMD, CORTEX_TEST_CMDGhi đè lệnh setup và lệnh test của project trên máy này
CORTEX_WORKER_HOMEThay cho ~/.cortex/worker

MIT License