Cài đặt Toolkit - Ayakaleaf Pro

Trang này mô tả các biến môi trường được hỗ trợ trong tệp config/overleaf.rc cho các triển khai bằng Toolkit. Tệp config/overleaf.rc bao gồm các định nghĩa biến ở 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 container Docker sau khi thay đổi bất kỳ nội dung nào trong overleaf.rc hoặc variables.env bằng cách chạy bin/up.

Container

`sharelatex`

Tên	Mô tả
`PROJECT_NAME`	Đặt giá trị của cờ `--project-name` được truyền cho `docker-compose`. Điều này hữu ích khi chạy nhiều phiên bản Overleaf trên cùng một máy chủ, vì mỗi phiên bản có thể có một tên dự án khác nhau. - Mặc định: `overleaf`
`OVERLEAF_IMAGE_NAME`	Docker image được container ứng dụng Server Pro/CE sử dụng. Đây chỉ là tên Docker image; tag của Docker image được lấy từ `config/version`. - Mặc định: - Server Pro: `ghcr.io/ayaka-notes/overleaf-pro` - Community Edition: `sharelatex/sharelatex`
`SERVER_PRO`	Khi được đặt là `true`, Toolkit sẽ dùng image Server Pro (`ghcr.io/ayaka-notes/overleaf-pro`) thay vì image Server CE mặc định (`sharelatex/sharelatex`). - Mặc định: `false`
`GIT_BRIDGE_ENABLED`	Đặt là `true` để bật tính năng git-bridge (chỉ Server Pro). Để biết thêm thông tin, xem tài liệu người dùng https://www.overleaf.com/learn/how-to/Git_integration. - Mặc định: `false`
`GIT_BRIDGE_IMAGE`	Docker image được container git-bridge sử dụng (chỉ Server Pro). Đây chỉ là tên Docker image; tag của Docker image được lấy từ `config/version`. - Mặc định: `ghcr.io/ayaka-notes/overleaf-pro/git-bridge`
`GIT_BRIDGE_DATA_PATH`	Đặt đường dẫn tới thư mục sẽ được gắn vào container `git-bridge` (chỉ Server Pro) và được dùng để lưu trữ các kho git. Đây có thể là đường dẫn đầy đủ (bắt đầu bằng `/`) hoặc đường dẫn tương đối so với thư mục gốc của Toolkit.
`GIT_BRIDGE_LOG_LEVEL`	Cấu hình mức ghi log của container `git-bridge`. Các mức khả dụng: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`. - Mặc định: `INFO`
`SIBLING_CONTAINERS_ENABLED`	Khi được đặt là `true`, Toolkit sẽ dùng kỹ thuật Sibling Containers để biên dịch các dự án trong các sandbox riêng biệt, sử dụng một container Docker riêng cho mỗi dự án. Xem tài liệu <server-pro-only-configuration/sandboxed-compiles> để biết thêm thông tin. - Yêu cầu: `SERVER_PRO=true` - Mặc định: `true`
`SIBLING_CONTAINERS_PULL`	Khi được đặt là `true`, Toolkit sẽ tự động tải về tất cả các image TeX Live được đặt bằng `ALL_TEX_LIVE_DOCKER_IMAGES` trong tệp config/variables.env khi dùng lệnh `bin/up`. - Mặc định: `true`
`DOCKER_SOCKET_PATH`	Đặt đường dẫn tới Docker socket trên máy chủ host (máy đang chạy Toolkit). Khi `SIBLING_CONTAINERS_ENABLED` là `true`, socket sẽ được gắn vào container để cho phép dịch vụ biên dịch tạo các container Docker mới trên máy chủ host. - Yêu cầu: `SIBLING_CONTAINERS_ENABLED=true` - Mặc định: `/var/run/docker.sock`
`OVERLEAF_DATA_PATH`	Đặt đường dẫn tới thư mục sẽ được gắn vào container `sharelatex` chính và được dùng để lưu trữ dữ liệu biên dịch. Đây có thể là đường dẫn đầy đủ (bắt đầu bằng `/`) hoặc đường dẫn tương đối so với thư mục gốc của Toolkit. - Mặc định: `data/overleaf`
`OVERLEAF_LISTEN_IP`	Đặt (các) địa chỉ IP của máy chủ host mà container sẽ bind vào. Ví dụ, nếu giá trị này được đặt là `0.0.0.0`, giao diện web sẽ khả dụng trên mọi địa chỉ IP của máy chủ host. Để truy cập trực tiếp vào container, giá trị của `OVERLEAF_LISTEN_IP` phải được đặt là địa chỉ IP công khai của bạn. Việc đặt `OVERLEAF_LISTEN_IP` là `0.0.0.0` hoặc IP bên ngoài của máy chủ host thường sẽ gây lỗi khi dùng kết hợp với . - Mặc định: `127.0.0.1`
`OVERLEAF_PORT`	Đặt cổng của máy chủ host mà container sẽ bind vào. Ví dụ, nếu giá trị này được đặt là `8099` và `OVERLEAF_LISTEN_IP` được đặt là `127.0.0.1`, giao diện web sẽ khả dụng tại `http://localhost:8099`. - Mặc định: `80`
`OVERLEAF_LOG_PATH`	Đặt đường dẫn tới thư mục sẽ được gắn vào container `sharelatex` chính và được dùng để cung cấp log của ứng dụng trên máy chủ Docker host. Đây có thể là đường dẫn đầy đủ (bắt đầu bằng `/`) hoặc đường dẫn tương đối so với thư mục gốc của Toolkit. Xóa mục cấu hình này để tắt bind-mount. Khi không được đặt, log sẽ bị loại bỏ khi tạo lại container. Xem để biết thông tin về việc ghi log. - Mặc định: không đặt

`mongo`

Tên	Mô tả
`MONGO_ENABLED`	Khi được đặt là `true`, Toolkit sẽ tạo một container MongoDB để chứa cơ sở dữ liệu. Khi được đặt là `false`, container này sẽ không được tạo và hệ thống sẽ dùng cơ sở dữ liệu MongoDB được chỉ định bởi `MONGO_URL`. - Mặc định: `true`
`MONGO_URL`	Chỉ định URL kết nối MongoDB được dùng khi `MONGO_ENABLED` là `false`. - Mặc định: không đặt
`MONGO_DATA_PATH`	Đặt đường dẫn tới thư mục sẽ được gắn vào container `mongo` và được dùng để lưu trữ cơ sở dữ liệu MongoDB. Đây có thể là đường dẫn đầy đủ (bắt đầu bằng `/`) hoặc đường dẫn tương đối so với thư mục gốc của toolkit. Tùy chọn này chỉ ảnh hưởng đến container `mongo` cục bộ được tạo khi `MONGO_ENABLED` là `true`. - Mặc định: `data/mongo`
`MONGO_IMAGE`	Docker image được container MongoDB sử dụng. Đây chỉ là tên Docker image; tag của Docker image nên được đặt trong `MONGO_VERSION` (xem bên dưới). - Mặc định: `mongo`
`MONGO_VERSION`	Phiên bản MongoDB được container MongoDB sử dụng. Giá trị phải bắt đầu bằng phiên bản chính của MongoDB và một dấu chấm, ví dụ `6.0` hoặc `6.0-with-suffix`. - Mặc định: `6.0`

`redis`

Tên	Mô tả
`REDIS_ENABLED`	Khi được đặt là `true`, Toolkit sẽ tạo một container Redis để chứa cơ sở dữ liệu redis. Khi được đặt là `false`, container này sẽ không được tạo và hệ thống sẽ dùng cơ sở dữ liệu Redis được chỉ định bởi `REDIS_HOST` và `REDIS_PORT`. - Mặc định: `true`
`REDIS_HOST`	Chỉ định máy chủ Redis được dùng khi `REDIS_ENABLED` là `false`. - Mặc định: không đặt
`REDIS_PORT`	Chỉ định cổng Redis được dùng khi `REDIS_ENABLED` là `false`. - Mặc định: không đặt
`REDIS_DATA_PATH`	Đặt đường dẫn tới thư mục sẽ được gắn vào container `redis` và được dùng để lưu trữ cơ sở dữ liệu Redis. Đây có thể là đường dẫn đầy đủ (bắt đầu bằng `/`) hoặc đường dẫn tương đối so với thư mục gốc của Toolkit. Tùy chọn này chỉ ảnh hưởng đến container `redis` cục bộ được tạo khi `REDIS_ENABLED` là `true`. - Mặc định: `data/redis`
`REDIS_AOF_PERSISTENCE`	Bật cơ chế lưu trữ bền vững AOF (Append Only File) cho Redis. Đây là cấu hình lưu trữ bền vững được khuyến nghị cho Redis. Để biết thêm chi tiết, xem phần <../../../maintenance/data-and-backups#aof-append-only-file> trong <../../maintenance/data-and-backups>. - Mặc định: `true`

`nginx`

Tên	Mô tả
`NGINX_ENABLED`	Khi được đặt là `true`, Toolkit sẽ tạo một container NGINX để làm TLS Proxy. - Mặc định: `false`
`NGINX_CONFIG_PATH`	Đường dẫn tới tệp cấu hình NGINX dùng cho TLS Proxy. - Mặc định: `config/nginx/nginx.conf`
`NGINX_TLS_LISTEN_IP`	Đặt (các) địa chỉ IP của máy chủ host mà container TLS Proxy sẽ bind vào cho HTTPS. Ví dụ, nếu giá trị này được đặt là `0.0.0.0`, giao diện web HTTPS sẽ khả dụng trên mọi địa chỉ IP của máy chủ host. Thông thường, giá trị này nên được đặt là IP bên ngoài của máy chủ host. - Mặc định: `127.0.1.1`
`NGINX_HTTP_LISTEN_IP`	Đặt (các) địa chỉ IP của máy chủ host mà container TLS Proxy sẽ bind vào để chuyển hướng HTTP. Ví dụ, nếu giá trị này được đặt là `127.0.1.1`, các kết nối HTTP tới `127.0.1.1` sẽ được chuyển hướng tới giao diện web HTTPS. Thông thường, giá trị này nên được đặt là IP bên ngoài của máy chủ host. Không đặt là `0.0.0.0` vì điều này thường sẽ gây xung đột với `OVERLEAF_LISTEN_IP`. - Mặc định: `127.0.1.1`
`NGINX_HTTP_PORT`	Đặt cổng của máy chủ host mà container TLS Proxy sẽ bind vào cho HTTP. - Mặc định: `80`
`TLS_PORT`	Đặt cổng của máy chủ host mà container TLS Proxy sẽ bind vào cho HTTPS. - Mặc định: `443`
`TLS_PRIVATE_KEY_PATH`	Đường dẫn tới khóa riêng (private key) dùng cho TLS Proxy. - Mặc định: `config/nginx/certs/overleaf_key.pem`
`TLS_CERTIFICATE_PATH`	Đường dẫn tới chứng chỉ công khai dùng cho TLS Proxy. - Mặc định: `config/nginx/certs/overleaf_certificate.pem`

Lần sửa đổi cuối 5 tháng 10, 2026