Tham chiếu cấu hình

Trang này liệt kê mọi khóa cấu hình mà ReputeCast đọc, kèm biến môi trường ReputeCast đặt từng khóa và giá trị mặc định.

ReputeCast tạo cấu hình từ năm lớp; lớp sau ghi đè lớp trước:

1. Giá trị mặc định có sẵn (cột Mặc định bên dưới).
2. Tệp YAML được chỉ định bằng --config hoặc REPUTECAST_CONFIG.
3. Biến môi trường REPUTECAST_*. Hai dấu gạch dưới phân tách các cấp: REPUTECAST_HTTP__PUBLIC_URL đặt http.public_url.
4. DATABASE_URL, chỉ khi REPUTECAST_DATABASE__URL chưa được đặt.
5. Các cờ dòng lệnh bạn truyền rõ ràng: --role, --addr, --database-url và --log-level.

Với khóa dạng danh sách (roles, http.trusted_proxies, secrets.previous_keys, dns.servers), hãy phân tách các giá trị trong biến môi trường bằng dấu phẩy. ReputeCast từ chối khởi động khi một giá trị không phân tích được, một vai trò không phải web, worker hoặc ingest, http.public_url không phải URL tuyệt đối, secrets.key không phải khóa 32 byte mã hóa base64, hoặc auth.password_min_length nhỏ hơn 8. Cấu hình ReputeCast giải thích các lớp này kèm một ví dụ YAML đầy đủ.

general

Khóa	Biến môi trường	Mặc định	Mô tả
envstring	REPUTECAST_ENV	production	Chế độ chạy: production hoặc development. development bật các lệnh seed và demo, các nhà cung cấp, DNS và dịch vụ khác được mô phỏng của bản demo, việc chuyển thư của bản demo đến mail.dev_smtp và ngôn ngữ giả (pseudo-locale). Hãy dùng production cho mọi hệ thống chạy thật.
roleslist	REPUTECAST_ROLES	web,worker,ingest	Các vai trò mà tiến trình này chạy: web (ứng dụng, API, trang công khai, MCP và SMTP relay), ingest (webhook của nhà cung cấp) và worker (tác vụ nền). Cờ --role của serve ghi đè giá trị này. Khi đặt bằng biến môi trường, hãy phân tách các vai trò bằng dấu phẩy.

http

Khóa	Biến môi trường	Mặc định	Mô tả
http.addrstring	REPUTECAST_HTTP__ADDR	:8080	Địa chỉ mà máy chủ HTTP lắng nghe. Cờ --addr của serve ghi đè giá trị này.
http.public_urlstring	REPUTECAST_HTTP__PUBLIC_URL	http://localhost:8080	Địa chỉ mà mọi người và các nhà cung cấp gửi thư dùng để truy cập hệ thống này. ReputeCast dựng URL webhook cho nhà cung cấp, chuyển hướng đăng nhập, khóa truy cập, trang công khai và liên kết trong email từ địa chỉ này, nên nhà cung cấp phải truy cập được nó từ internet. Phải là URL tuyệt đối; địa chỉ https:// sẽ bật HSTS và cookie Secure. URL công khai lưu trong Quản trị hệ thống › Hệ thống và cập nhật sẽ thay thế giá trị này.
http.trusted_proxieslist	REPUTECAST_HTTP__TRUSTED_PROXIES	—	Địa chỉ IP hoặc dải CIDR của các reverse proxy của bạn. Chỉ yêu cầu đến từ các địa chỉ này mới được đặt địa chỉ máy khách bằng X-Forwarded-For hoặc X-Real-IP; giới hạn tốc độ và nhật ký kiểm tra dùng địa chỉ máy khách đó. Khi đặt bằng biến môi trường, hãy phân tách các mục bằng dấu phẩy.
http.rate_limit_authint	REPUTECAST_HTTP__RATE_LIMIT_AUTH	30	Số yêu cầu mỗi phút mà mỗi địa chỉ IP máy khách được gửi đến các endpoint đăng nhập (/api/v1/auth/*).
http.rate_limit_apiint	REPUTECAST_HTTP__RATE_LIMIT_API	600	Số yêu cầu mỗi phút mà mỗi khóa API được gửi đến API, hoặc mỗi địa chỉ IP với phiên trình duyệt. Giá trị 0 trở xuống sẽ tắt cả giới hạn này lẫn http.rate_limit_auth.
http.read_timeoutduration	REPUTECAST_HTTP__READ_TIMEOUT	30s	Thời gian tối đa máy chủ chờ để đọc xong một yêu cầu, kể cả phần thân.
http.write_timeoutduration	REPUTECAST_HTTP__WRITE_TIMEOUT	60s	Thời gian tối đa máy chủ dành để ghi một phản hồi.
http.shutdown_timeoutduration	REPUTECAST_HTTP__SHUTDOWN_TIMEOUT	20s	Thời gian một tiến trình đang dừng chờ các yêu cầu đang mở hoàn tất.

database

Khóa	Biến môi trường	Mặc định	Mô tả
database.urlstring	REPUTECAST_DATABASE__URL	postgres://reputecast:reputecast@localhost:5432/reputecast?sslmode=disable	URL kết nối PostgreSQL. Khi chưa đặt REPUTECAST_DATABASE__URL, DATABASE_URL sẽ được dùng thay thế. Cờ --database-url ghi đè cả hai. Giá trị mặc định khớp với cơ sở dữ liệu phát triển.
database.max_connsint	REPUTECAST_DATABASE__MAX_CONNS	20	Kích thước nhóm kết nối (connection pool) của mỗi tiến trình. Hãy giữ tổng của mọi tiến trình dưới max_connections của PostgreSQL.

secrets

Khóa	Biến môi trường	Mặc định	Mô tả
secrets.keystring	REPUTECAST_SECRETS__KEY	—	Khóa 32 byte mã hóa Base64, dùng để mã hóa thông tin xác thực của nhà cung cấp và các bí mật khác trong cơ sở dữ liệu (AES-256-GCM). Tạo khóa bằng reputecast secrets generate-key. Khi để trống, khóa được đọc từ secrets.key_file. Hãy sao lưu khóa cùng cơ sở dữ liệu: thiếu khóa, thông tin xác thực đã lưu không thể giải mã.
secrets.previous_keyslist	REPUTECAST_SECRETS__PREVIOUS_KEYS	—	Các khóa trước đây, vẫn được chấp nhận để giải mã trong lúc bạn xoay vòng khóa. Để xoay vòng, hãy chuyển khóa hiện tại vào đây và đặt một secrets.key mới. Khi đặt bằng biến môi trường, hãy phân tách các khóa bằng dấu phẩy.
secrets.key_filestring	REPUTECAST_SECRETS__KEY_FILE	data/secret.key	Tệp chứa khóa khi secrets.key để trống, tính tương đối từ thư mục làm việc trừ khi là đường dẫn tuyệt đối. Nếu tệp chưa tồn tại, ReputeCast tạo tệp với một khóa mới (quyền 0600) và ghi cảnh báo vào log để nhắc bạn sao lưu. Docker image đặt /var/lib/reputecast/secret.key.

log

Khóa	Biến môi trường	Mặc định	Mô tả
log.levelstring	REPUTECAST_LOG__LEVEL	info	Mức log thấp nhất được ghi: debug, info, warn hoặc error. Cờ --log-level ghi đè giá trị này.
log.formatstring	REPUTECAST_LOG__FORMAT	text	Định dạng log, text hoặc json. Log được ghi ra standard error. Docker image đặt json.

auth

Khóa	Biến môi trường	Mặc định	Mô tả
auth.session_idleduration	REPUTECAST_AUTH__SESSION_IDLE	12h	Thời gian chờ khi không hoạt động, chỉ dùng khi không đọc được chính sách xác thực từ cơ sở dữ liệu. Hãy đặt thời gian chờ này trong Quản trị hệ thống › Xác thực.
auth.cookie_namestring	REPUTECAST_AUTH__COOKIE_NAME	rc_session	Tên cookie phiên.
auth.cookie_securebool	REPUTECAST_AUTH__COOKIE_SECURE	true	Đánh dấu cookie phiên là Secure để trình duyệt chỉ gửi cookie qua HTTPS. Bị bỏ qua ở chế độ phát triển. Khi http.public_url bắt đầu bằng https://, cookie luôn là Secure.
auth.password_min_lengthint	REPUTECAST_AUTH__PASSWORD_MIN_LENGTH	12	Độ dài tối thiểu của mật khẩu đặt bằng reputecast install và reputecast user reset-password --password. Ít nhất là 8. Mật khẩu đặt trong ứng dụng tuân theo chính sách trong Quản trị hệ thống › Xác thực.

worker

Khóa	Biến môi trường	Mặc định	Mô tả
worker.concurrencyint	REPUTECAST_WORKER__CONCURRENCY	50	Số tác vụ nền mà một tiến trình worker chạy cùng lúc trên hàng đợi gửi. Các hàng đợi khác nhận một phần của con số này: events một nửa, default một phần tư và system một phần năm, mỗi hàng đợi ít nhất 2. Giá trị dưới 4 được tính là 4.

updates

Khóa	Biến môi trường	Mặc định	Mô tả
updates.checkbool	REPUTECAST_UPDATES__CHECK	true	Cho phép kiểm tra hằng ngày xem có bản phát hành ReputeCast mới hơn trên GitHub và plugin WordPress mới hơn hay không. false tắt cả hai cho toàn hệ thống. Khi là true, quản trị viên hệ thống vẫn có thể tắt việc kiểm tra trong Quản trị hệ thống › Hệ thống và cập nhật.
updates.repostring	REPUTECAST_UPDATES__REPO	hostrepute/reputecast	Kho GitHub mà việc kiểm tra bản phát hành đọc, ở dạng owner/name.

metrics

Khóa	Biến môi trường	Mặc định	Mô tả
metrics.enabledbool	REPUTECAST_METRICS__ENABLED	true	Cung cấp số liệu Prometheus tại /metrics.
metrics.addrstring	REPUTECAST_METRICS__ADDR	—	Địa chỉ lắng nghe riêng cho /metrics, ví dụ :9090. Để trống thì /metrics được phục vụ trên cổng HTTP chính. Tiến trình chỉ chạy vai trò worker không có cổng lắng nghe chính, nên hãy đặt giá trị này để thu thập số liệu của nó.

webhooks

Khóa	Biến môi trường	Mặc định	Mô tả
webhooks.allow_private_networksbool	REPUTECAST_WEBHOOKS__ALLOW_PRIVATE_NETWORKS	false	Cho phép các URL mà ReputeCast gửi webhook đến (endpoint webhook, luồng nhật ký kiểm tra, hook tích hợp như một n8n nội bộ, và webhook phần thưởng giới thiệu) phân giải ra địa chỉ loopback và địa chỉ riêng (RFC 1918). Tắt theo mặc định để người dùng không truy cập được dịch vụ nội bộ. Địa chỉ link-local và địa chỉ metadata của đám mây luôn bị chặn.

providers

Khóa	Biến môi trường	Mặc định	Mô tả
providers.allow_private_networksbool	REPUTECAST_PROVIDERS__ALLOW_PRIVATE_NETWORKS	false	Cho phép các địa chỉ mà quản trị viên không gian làm việc nhập cho dịch vụ bên ngoài phân giải ra địa chỉ loopback và địa chỉ riêng (RFC 1918): API và máy chủ SMTP của nhà cung cấp gửi thư, tiến trình adapter cộng đồng, máy chủ mô hình AI, công cụ nhập dữ liệu, nguồn cấp, dịch vụ xác minh, hộp thư thử và các dịch vụ đã kết nối khác. Tắt theo mặc định để người dùng không truy cập được dịch vụ nội bộ. Địa chỉ link-local và địa chỉ metadata của đám mây luôn bị chặn. Adapter cộng đồng ở các địa chỉ này có thể dùng http:// thường.

hostrepute

Khóa	Biến môi trường	Mặc định	Mô tả
hostrepute.api_urlstring	REPUTECAST_HOSTREPUTE__API_URL	https://api.hostrepute.com/v1	URL gốc của API HostRepute cho các kết nối mới.
hostrepute.auth_urlstring	REPUTECAST_HOSTREPUTE__AUTH_URL	https://app.hostrepute.com/oauth/authorize	Endpoint ủy quyền OAuth của HostRepute.
hostrepute.token_urlstring	REPUTECAST_HOSTREPUTE__TOKEN_URL	https://api.hostrepute.com/oauth/token	Endpoint token OAuth của HostRepute.
hostrepute.revoke_urlstring	REPUTECAST_HOSTREPUTE__REVOKE_URL	https://api.hostrepute.com/oauth/revoke	Endpoint thu hồi token OAuth của HostRepute, được gọi khi một không gian làm việc ngắt kết nối.
hostrepute.client_idstring	REPUTECAST_HOSTREPUTE__CLIENT_ID	reputecast	Client ID OAuth. ReputeCast kết nối như một public client với PKCE; chỉ đặt giá trị này và hostrepute.client_secret nếu bạn đã đăng ký client riêng với HostRepute.
hostrepute.client_secretstring	REPUTECAST_HOSTREPUTE__CLIENT_SECRET	—	Client secret OAuth của client bạn tự đăng ký. Để trống nếu dùng public client mặc định.
hostrepute.demobool	REPUTECAST_HOSTREPUTE__DEMO	false	Dùng một HostRepute ngoại tuyến có sẵn, với dữ liệu mẫu và phê duyệt OAuth tức thì, để phát triển và chụp ảnh màn hình.

dns

Khóa	Biến môi trường	Mặc định	Mô tả
dns.serverslist	REPUTECAST_DNS__SERVERS	—	Các DNS resolver dùng cho kiểm tra xác thực và tra cứu danh sách chặn, ở dạng host hoặc host:port. Để trống thì dùng resolver của hệ điều hành. Các danh sách chặn như Spamhaus từ chối truy vấn đi qua resolver công cộng, nên hãy dùng resolver của riêng bạn. Khi đặt bằng biến môi trường, hãy phân tách các máy chủ bằng dấu phẩy.
dns.timeoutduration	REPUTECAST_DNS__TIMEOUT	4s	Thời gian chờ của một lượt tra cứu DNS.

mail

Khóa	Biến môi trường	Mặc định	Mô tả
mail.dev_smtpstring	REPUTECAST_MAIL__DEV_SMTP	localhost:1025	Chỉ dùng khi phát triển: địa chỉ SMTP (host:port) của một công cụ hứng thư như Mailpit, nơi thư của các nhà cung cấp mẫu trong bản demo được chuyển đến thay vì một nhà cung cấp thật.

connect

Khóa	Biến môi trường	Mặc định	Mô tả
connect.ses_template_urlstring	REPUTECAST_CONNECT__SES_TEMPLATE_URL	https://reputecast.com/cf/reputecast-ses.yaml	Template CloudFormation mà liên kết Khởi chạy stack trong AWS mở ra khi bạn kết nối Amazon SES. Hãy trỏ đến bản sao do bạn tự xuất bản để dùng một template khác.

i18n

Khóa	Biến môi trường	Mặc định	Mô tả
i18n.pseudo_localebool	REPUTECAST_I18N__PSEUDO_LOCALE	false	Cung cấp ngôn ngữ ứng dụng Pseudo (+40%) ngoài chế độ phát triển, để kiểm tra bố cục trên một hệ thống staging. Mọi chuỗi đều được thêm dấu, dài hơn khoảng 40% và được bọc trong ⟦ ⟧. Chế độ phát triển luôn có ngôn ngữ này.

files

Khóa	Biến môi trường	Mặc định	Mô tả
files.dirstring	REPUTECAST_FILES__DIR	—	Thư mục chứa tệp tải lên như sản phẩm số và tài liệu thu hút khách hàng tiềm năng (lead magnet). Để trống thì dùng thư mục files cạnh secrets.key_file (/var/lib/reputecast/files trong Docker image). Khi bạn chia vai trò ra nhiều máy, mọi tiến trình web và worker cần dùng chung một thư mục.

Biến chỉ đặt qua môi trường

Biến môi trường	Mặc định	Mô tả
REPUTECAST_CONFIGstring	—	Đường dẫn đến tệp cấu hình YAML, được đọc khi không truyền cờ --config.
DATABASE_URLstring	—	URL kết nối PostgreSQL, được dùng khi chưa đặt REPUTECAST_DATABASE__URL. Biến này ghi đè database.url trong tệp cấu hình.
REPUTECAST_AUTO_MIGRATEbool	false	Giá trị mặc định của reputecast serve --auto-migrate: true áp dụng các migration đang chờ khi khởi động. Lệnh khởi động của Docker image truyền cờ này, và tệp docker-compose.yml đi kèm đặt biến này thành true.
REPUTECAST_AUTO_INSTALLbool	false	Giá trị mặc định của reputecast serve --auto-install: true tạo Chủ sở hữu đầu tiên khi khởi động nếu cơ sở dữ liệu chưa có người dùng. Lệnh khởi động của Docker image truyền cờ này, và tệp docker-compose.yml đi kèm đặt biến này thành true.
REPUTECAST_ADMIN_EMAILstring	—	Email của Chủ sở hữu đầu tiên, được reputecast install đọc khi không truyền --email, và được serve --auto-install đọc. Tệp docker-compose.yml đi kèm truyền [email protected] khi bạn không đặt biến này.
REPUTECAST_ADMIN_NAMEstring	—	Tên của Chủ sở hữu đầu tiên, được reputecast install đọc khi không truyền --name, và được serve --auto-install đọc.
REPUTECAST_ADMIN_PASSWORDstring	—	Mật khẩu của Chủ sở hữu đầu tiên, được reputecast install đọc khi không truyền --password, và được serve --auto-install đọc. Khi chưa đặt biến này, một mật khẩu tạm thời sẽ được in ra thay thế.
REPUTECAST_IMAGEstring	ghcr.io/hostrepute/reputecast	Do tệp docker-compose.yml đi kèm đọc, không phải ReputeCast: image mà service app chạy. Đặt thành reputecast cùng REPUTECAST_VERSION=local để chạy image bạn tự build từ mã nguồn bằng make docker VERSION=local.
REPUTECAST_VERSIONstring	latest	Do tệp docker-compose.yml đi kèm đọc, không phải ReputeCast: tag của image mà service app chạy.
REPUTECAST_PORTint	8080	Do tệp docker-compose.yml đi kèm đọc, không phải ReputeCast: cổng trên máy chủ được ánh xạ đến cổng 8080 của container app.
REPUTECAST_PUBLIC_URLstring	http://localhost:8080	Do tệp docker-compose.yml đi kèm đọc và truyền cho ứng dụng dưới dạng REPUTECAST_HTTP__PUBLIC_URL. Đặt biến này cho một binary bạn tự chạy sẽ không có tác dụng; khi đó hãy đặt REPUTECAST_HTTP__PUBLIC_URL.
POSTGRES_PASSWORDstring	reputecast	Do tệp docker-compose.yml đi kèm đọc: mật khẩu của người dùng reputecast trong service postgres, cũng được dùng trong URL cơ sở dữ liệu của ứng dụng. Hãy đặt mật khẩu của riêng bạn trước lần khởi động đầu tiên.
REPUTECAST_ADAPTER_SECRETlist	—	Do các tiến trình adapter cộng đồng xây dựng bằng adapter SDK đọc: khóa bí mật ký mà reputecast adapter install hoặc reputecast adapter secret đã in ra. Trong lúc xoay vòng, hãy đặt nhiều khóa bí mật, phân tách bằng dấu phẩy.
REPUTECAST_ADAPTER_ALLOW_HOSTSlist	—	Do các tiến trình adapter cộng đồng xây dựng bằng adapter SDK đọc: các host bổ sung mà adapter được phép gọi, ngoài các host trong manifest của nó, phân tách bằng dấu phẩy, ví dụ một nhà cung cấp giả lập chạy cục bộ khi kiểm thử.
REPUTECAST_ADAPTER_LOG_LEVELstring	info	Do các tiến trình adapter cộng đồng xây dựng bằng adapter SDK đọc: mức log thấp nhất được ghi, debug, info, warn hoặc error.
PORTint	4600	Do các tiến trình adapter cộng đồng xây dựng bằng adapter SDK đọc: cổng mà adapter lắng nghe.
HOSTstring	127.0.0.1	Do các tiến trình adapter cộng đồng xây dựng bằng adapter SDK đọc: địa chỉ mà adapter lắng nghe. Docker image của adapter template đặt 0.0.0.0.

Liên quan

• Cài đặt bằng Docker Compose cho thấy nơi tệp Compose đặt các biến này.
• Reverse proxy và TLS trình bày http.public_url và http.trusted_proxies.
• Bảo mật và tăng cường bảo mật giải thích khóa bí mật và việc xoay vòng khóa.
• Tham chiếu CLI liệt kê các lệnh đọc cấu hình này.