Biến môi trường

Trang này mô tả các biến môi trường được hỗ trợ trong tệp config/variables.env cho các bản triển khai bằng Toolkit.

Tệp config/variables.env bao gồm các định nghĩa biến theo dạng NAME=value; các dòng bắt đầu bằng # được coi là chú thích.

Bạn cần tạo lại các Docker container sau khi thay đổi bất kỳ điều gì trong overleaf.rc hoặc variables.env bằng cách chạy bin/up.

​

Tất cả các phiên bản

Các biến môi trường này tương thích với Server CE và Server Pro, đồng thời cung cấp lộ trình di chuyển dễ dàng giữa hai phiên bản on-premise này. Chúng cũng có thể được dùng cho cả bản triển khai bằng Toolkit lẫn Docker Compose.

Trước đây, các biến môi trường này có tiền tố SHARELATEX_ thay vì OVERLEAF_.

Tên	Mô tả
OVERLEAF_SITE_URL	Địa chỉ công khai của phiên bản Overleaf của bạn. Giá trị này được dùng trong các liên kết công khai và khi kết nối qua websocket, vì vậy phải được cấu hình chính xác!
OVERLEAF_ADMIN_EMAIL	Địa chỉ email mà người dùng có thể liên hệ với người vận hành trang.
OVERLEAF_APP_NAME	Tên hiển thị khi đề cập đến ứng dụng đang chạy. Mặc định là ‘Overleaf (Community Edition)’.
OVERLEAF_MONGO_URL và MONGO_URL	URL của cơ sở dữ liệu Mongo sẽ sử dụng.
OVERLEAF_REDIS_HOST và REDIS_HOST	Tên host của phiên bản Redis sẽ sử dụng. Cả hai biến đều bắt buộc (xem ghi chú phát hành).
OVERLEAF_REDIS_PORT và REDIS_PORT	Cổng của phiên bản Redis sẽ sử dụng. Cả hai biến đều bắt buộc (xem ghi chú phát hành).
OVERLEAF_REDIS_PASS và REDIS_PASSWORD	Mật khẩu dùng khi kết nối tới Redis (nếu có). Cần đặt cả hai biến môi trường. Xem bật xác thực bằng mật khẩu để biết thêm thông tin.
OVERLEAF_REDIS_TLS	Nếu đặt thành true, cho phép kết nối tới phiên bản Redis yêu cầu TLS. Lưu ý: mTLS hiện chưa được hỗ trợ.
OVERLEAF_NAV_TITLE	Đặt tiêu đề tab của ứng dụng.
OVERLEAF_HEADER_IMAGE_URL_LIGHT và OVERLEAF_HEADER_IMAGE_URL_DARK	URL của logo header tùy chỉnh cho giao diện sáng và tối (được thêm vào trong 6.3.0). Mỗi giao diện sẽ dùng OVERLEAF_HEADER_IMAGE_URL làm giá trị dự phòng khi biến riêng của nó không được đặt. Xem Branding.
OVERLEAF_LINKED_URL_OUTBOUND_PROXY	URL của một proxy HTTP(S) dùng để tải các tệp liên kết bên ngoài và các tài nguyên ZIP hoặc TeX bên ngoài thông qua API Open in Overleaf. Có sẵn từ bản phát hành lại Ayakaleaf Pro 6.3.0 (ngày 3 tháng 10 năm 2026). Để trống để kết nối trực tiếp. Ví dụ: OVERLEAF_LINKED_URL_OUTBOUND_PROXY=http://proxy.internal:3128. Xem Outbound Proxy để biết về cấu hình và các hạn chế truy cập mạng.
OVERLEAF_INVITE_TOKEN_SECRET	Bắt buộc. Một chuỗi ngẫu nhiên dùng để bảo mật các token chia sẻ dự án (được thêm vào trong Server Pro 6.2.0). Số ký tự tối thiểu: 16
OVERLEAF_SESSION_SECRET	Một chuỗi ngẫu nhiên dùng để bảo mật các token; nếu sử dụng cân bằng tải, giá trị này cần được đặt giống nhau trên tất cả các máy. Nếu chỉ chạy 1 phiên bản, người dùng không cần đặt giá trị này.
OVERLEAF_COOKIE_SESSION_LENGTH	Cho phép ghi đè thời gian hết hạn mặc định 5 ngày của cookie phiên. Giá trị ghi đè tính bằng mili giây. Ví dụ: để phiên kéo dài 1 giờ, hãy đặt COOKIE_SESSION_LENGTH=3600000. (Được thêm vào trong Server Pro 4.2)
OVERLEAF_TRUSTED_PROXY_IPS	Nếu không được đặt, giá trị mặc định là loopback. Nếu đặt thủ công, ngoài các IP tin cậy của bạn, bạn cũng phải thêm loopback (hoặc 127.0.0.1), để tin cậy phiên bản nginx chạy bên trong container sharelatex. Chỉ chấp nhận địa chỉ IP và dải CIDR: không thêm tên host như localhost, nếu không Overleaf sẽ không khởi động được và trả về 502 Bad Gateway. Nếu bạn dùng một subnet thuộc 172.16.0.0/12 (subnet mặc định cho mạng Docker) cho mạng thông thường của mình, vui lòng đặt OVERLEAF_TRUSTED_PROXY_IPS=loopback,<network> trong config/variables.env. Trong đó <network> là giá trị IPAM -> Config -> Subnet trong docker inspect overleaf_default, ví dụ OVERLEAF_TRUSTED_PROXY_IPS=loopback,172.19.0.0/16. Điều này nhằm ngăn chặn việc giả mạo các header X-Forwarded. Nếu bạn đang dùng một TLS proxy bên ngoài (tức là không do Overleaf Toolkit quản lý), hãy đảm bảo OVERLEAF_TRUSTED_PROXY_IPS=loopback,<ip-of-your-tls-proxy>, ví dụ OVERLEAF_TRUSTED_PROXY_IPS=loopback,192.168.13.37.
OVERLEAF_RESTRICT_INVITES_TO_EXISTING_ACCOUNTS	Nếu đặt thành true, lời mời tham gia dự án sẽ chỉ giới hạn cho các địa chỉ email tương ứng với tài khoản người dùng đã tồn tại.
OVERLEAF_ALLOW_PUBLIC_ACCESS	Nếu đặt thành true, cho phép người dùng chưa xác thực xem trang. Mặc định là false, nghĩa là người dùng chưa xác thực sẽ luôn bị chuyển hướng đến trang đăng nhập khi cố gắng xem bất kỳ phần nào của trang. Lưu ý, việc đặt tùy chọn này không hề vô hiệu hóa xác thực hay bảo mật theo bất kỳ cách nào. Tùy chọn này cần thiết nếu người dùng của bạn muốn công khai dự án và cho phép người dùng chưa xác thực xem các dự án đó.
OVERLEAF_ALLOW_ANONYMOUS_READ_AND_WRITE_SHARING	Nếu đặt thành true, cho phép người dùng ẩn danh xem và chỉnh sửa các dự án được chia sẻ qua tính năng chia sẻ bằng liên kết.
OVERLEAF_DISABLE_LINK_SHARING	Vô hiệu hóa tính năng chia sẻ bằng liên kết.
EMAIL_CONFIRMATION_DISABLED	Khi đặt thành true, banner yêu cầu xác nhận email sẽ không được hiển thị.
ADDITIONAL_TEXT_EXTENSIONS	Một mảng các chuỗi để cấu hình thêm phần mở rộng cho các tệp có thể chỉnh sửa.
DEFAULT_LATEX_COMPILER	Dùng để đặt trình biên dịch mặc định cho các dự án mới. (Được thêm vào trong Server Pro 6.2.0). Tùy chọn: pdflatex, latex, xelatex hoặc lualatex
OVERLEAF_STATUS_PAGE_URL	URL trang trạng thái tùy chỉnh (được thêm vào trong Server Pro 3.4.0), ví dụ status.example.com.
OVERLEAF_FPH_INITIALIZE_NEW_PROJECTS	Đặt thành 'false' để ngăn các dự án mới được khởi tạo với Full Project History (được thêm vào trong Server Pro 3.5.0).
OVERLEAF_FPH_DISPLAY_NEW_PROJECTS	Đặt thành 'false' để ngăn các dự án mới hiển thị Full Project History thay cho lịch sử kiểu cũ (được thêm vào trong Server Pro 3.5.0).
ENABLE_CRON_RESOURCE_DELETION	Đặt biến môi trường này thành true để bật tính năng tự động dọn dẹp các dự án và người dùng đã bị xóa sau 90 ngày.
OVERLEAF_USER_HARD_DELETION_DELAY	Dùng để thay đổi thời gian chờ trước khi người dùng đã xóa hết hạn. Cấu hình bằng mili giây. Mặc định: 90 ngày
OVERLEAF_PROJECT_HARD_DELETION_DELAY	Dùng để thay đổi thời gian chờ trước khi dự án đã xóa hết hạn. Cấu hình bằng mili giây. Mặc định: 90 ngày
MAX_UPLOAD_SIZE	Kiểm soát kích thước tối đa của mỗi lần tải lên, tính bằng megabyte. Mặc định là 50. Chú ý: Biến này chỉ là một số thuần, không kèm đơn vị (MB) hay ký tự bao quanh. Tổng kích thước sau giải nén của một tệp .zip được tải lên bị giới hạn ở 6 × giá trị này (mặc định là 300 MB).
COMPILE_SIZE_LIMIT	Kiểm soát kích thước tối đa của phần thân yêu cầu, tính bằng byte. Đây là tổng kích thước của tất cả các tệp doc trong dự án (main.tex, references.bib (nếu không được liên kết), v.v.) cần được gửi trong yêu cầu biên dịch ban đầu tới dịch vụ CLSI.
COMPILE_TIMEOUT	Khoảng thời gian tính bằng giây cho phép để hoàn tất một lần biên dịch. Để biết thêm thông tin, xem Cập nhật thời gian chờ biên dịch dự án.
MAX_RECONNECT_GRACEFULLY_INTERVAL_MS	Một khoảng trễ có thể cấu hình giữa việc kết nối lại nhẹ nhàng (graceful) của trình soạn thảo, việc đẩy dữ liệu (flush) và việc tắt container, nhằm giảm thiểu nguy cơ mất dữ liệu.
SECCOMP_PROFILE	Đặt biến môi trường này thành một đường dẫn trên máy host Docker trỏ tới SECCOMP profile. Bạn có thể tải xuống một bản sao của profile tại đây. Hiện cần thiết cho các bản triển khai Podman khi sử dụng Sandboxed Compiles.
OVERLEAF_DISABLE_CHAT	Nếu đặt thành true, vô hiệu hóa tính năng trò chuyện trong dự án.
OVERLEAF_LOGIN_SUPPORT_TEXT	Khi được đặt, có thể dùng để hiển thị thông tin hỗ trợ bên dưới nút đăng nhập. Văn bản sẽ được hiển thị trên màn hình đăng nhập và có thể dùng để hướng người dùng đến bộ phận hỗ trợ nội bộ hoặc cung cấp hướng dẫn liên quan đến việc đăng nhập, tạo tài khoản, v.v.
ALLOW_MONGO_ADMIN_CHECK_FAILURES	Nếu đặt thành true, cho phép các bước kiểm tra khởi động MongoDB thất bại mà không ngăn bản triển khai khởi động. Điều này có thể cần thiết nếu bạn dùng một cơ sở dữ liệu MongoDB mà người dùng cơ sở dữ liệu của bạn không có vai trò clusterParameterReader. Để được trợ giúp về việc tạo vai trò tùy chỉnh, xem tại đây.
V1_HISTORY_URL_FOR_GIT_BRIDGE	Cho phép tách endpoint history-v1 cho lưu lượng nội bộ (dịch vụ web → dịch vụ history-v1, cả hai đều trong container sharelatex) và lưu lượng bên ngoài (git-bridge → history-v1, chạy trong các container riêng biệt).
OVERLEAF_MAINTENANCE_MESSAGE và OVERLEAF_MAINTENANCE_MESSAGE_HTML	Dùng để tùy chỉnh tiêu đề và nội dung của trang Bảo trì. Không thể dùng cùng với OVERLEAF_STATUS_PAGE_URL.

Có thể áp dụng các ràng buộc về mật khẩu cho người dùng khi sử dụng hệ thống đăng nhập của Overleaf (tài khoản cục bộ), chứ không phải tùy chọn SSO như LDAP. Đối với tài khoản SSO, chính sách mật khẩu sẽ do nhà cung cấp định danh hoặc dịch vụ thư mục của bạn áp dụng, đồng thời cho phép hỗ trợ xác thực đa yếu tố.