Dữ liệu lưu trữ lâu dài
Overleaf Toolkit cần lưu trữ dữ liệu lâu dài, chẳng hạn như các tệp cần thiết để biên dịch dự án LaTeX và nội dung của cơ sở dữ liệu MongoDB. Điều này được thực hiện bằng cách mount một số thư mục từ máy chủ host vào các Docker container và ghi dữ liệu vào các thư mục đó.Thư mục dữ liệu
Containersharelatex cần một thư mục để lưu trữ dữ liệu liên quan đến việc biên dịch LaTeX. Thư mục này được đặt bằng biến OVERLEAF_DATA_PATH trong config/overleaf.rc.
Container mongo, nếu được bật, cần một thư mục để lưu các tệp cơ sở dữ liệu, và điều tương tự cũng áp dụng cho container redis. Các thư mục này cũng có thể được cấu hình trong config/overleaf.rc.
Quyền truy cập tệp
Vì Docker chạy dưới quyềnroot, các thư mục dữ liệu sẽ thuộc sở hữu của người dùng root, ngay cả khi Toolkit được sử dụng bởi người dùng không phải root. Đây không phải là vấn đề, nhưng bạn nên lưu ý nếu định thay đổi dữ liệu lưu trữ từ bên ngoài các container.
Vị trí tệp cấu hình
Tất cả các tệp cấu hình do người dùng sở hữu đều nằm trong thư mụcconfig/.
Thư mục này được loại trừ khỏi hệ thống quản lý phiên bản git, vì vậy nó sẽ không bị thay đổi khi cập nhật mã nguồn Toolkit. Toolkit sẽ không thay đổi bất kỳ dữ liệu nào trong thư mục config/ khi chưa có sự cho phép của bạn.
Các thay đổi trong tệp cấu hình sẽ không được tự động áp dụng cho các container hiện có, ngay cả khi container bị dừng và khởi động lại (bằng
bin/stop và bin/start). Để áp dụng thay đổi, hãy chạy bin/up, và ở phía sau, docker compose sẽ tự động áp dụng các thay đổi cấu hình cho một container mới. (Hoặc chạy bin/up -d nếu bạn không muốn gắn vào log của Docker.)Tệp config/overleaf.rc
Tệp config/overleaf.rc chứa các thiết lập cấu hình cấp cao quan trọng nhất được Toolkit sử dụng. Tệp này chứa các câu lệnh gán biến theo định dạng: VARIABLE_NAME=value
Để xem chi tiết tất cả các tùy chọn cấu hình khả dụng, hãy xem phần thiết lập của chúng tôi.
Tệp variables.env
Tệp config/variables.env chứa các biến môi trường được nạp vào container sharelatex và dùng để cấu hình các microservice của Overleaf. Chúng bao gồm tên ứng dụng (hiển thị trên header của giao diện web), thiết lập gửi email và các thiết lập khác như SSO.
Để xem chi tiết tất cả các biến môi trường khả dụng, hãy xem phần Biến môi trường.
Tệp config/version
Tệp config/version chứa số phiên bản của Docker image sẽ được dùng để tạo phiên bản đang chạy của máy chủ Overleaf.
Các thay đổi trong những tệp cấu hình này sẽ không được tự động áp dụng cho các container hiện có, ngay cả khi container bị dừng và khởi động lại (bằng
bin/stop và bin/start). Để áp dụng thay đổi, hãy chạy bin/up, và Toolkit sẽ tự động tạo một container mới với các thay đổi cấu hình đã được áp dụng.Tệp docker-compose.override.yml
Nếu tồn tại, tệp config/docker-compose.override.yml sẽ được đưa vào khi gọi docker compose. Điều này hữu ích để ghi đè các cấu hình dành riêng cho Docker Compose.
config/variables.env không được nạp vào các container mongo và redis. Để đặt một biến môi trường trong các container đó, hãy thêm nó vào đây và chạy bin/up -d, ví dụ:
Hỏi & Đáp
Các thư mục dữ liệu nên dùng hệ thống tệp nào? Tôi có thể dùng btrfs, copy-on-write hoặc nén zstd không?
Các thư mục dữ liệu nên dùng hệ thống tệp nào? Tôi có thể dùng btrfs, copy-on-write hoặc nén zstd không?
Trả lời: Toolkit không kiểm tra hệ thống tệp. Thành phần có yêu cầu là MongoDB, vì vậy lựa chọn này quan trọng nhất đối với
data/mongo (MONGO_DATA_PATH). Ghi chú vận hành production của MongoDB khuyên dùng XFS hoặc ext4 trên Linux, và đặc biệt khuyến nghị XFS với WiredTiger, storage engine mà MongoDB sử dụng. Các ghi chú này không đề cập đến btrfs hoặc các hệ thống tệp copy-on-write khác. Nếu hệ thống tệp gốc của bạn là btrfs, bạn có thể mount một volume XFS và trỏ MONGO_DATA_PATH đến đó. Hệ thống tệp cũng phải hỗ trợ fsync() trên thư mục, điều mà HGFS và thư mục chia sẻ của VirtualBox không hỗ trợ.Nén ở cấp hệ thống tệp tiết kiệm được rất ít cho data/mongo: WiredTiger đã nén các collection bằng snappy và các index bằng prefix compression. Với NFS, xem Khắc phục sự cố.
