2. Làm quen với Toolkit

​

Xem qua một lượt

Bây giờ bạn đã có bản sao cục bộ của Toolkit, hãy xem cấu trúc của kho mã bằng lệnh ls.

Run this

ls -l

Lệnh ls -l hiển thị danh sách chi tiết nội dung của một thư mục, cung cấp thêm thông tin về tệp như quyền truy cập, chủ sở hữu và kích thước.

Nếu mọi thứ được clone thành công, bạn sẽ thấy kết quả tương tự như sau:

drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 bin
-rw-r--r-- 1 fry fry  6465 Aug 30 14:16 CHANGELOG.md
drwxr-xr-x 2 fry fry  4096 Sep  6 12:43 config
drwxr-xr-x 5 fry fry  4096 Aug 30 14:22 data
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 doc
drwxr-xr-x 3 fry fry  4096 Aug 30 14:16 lib
-rw-r--r-- 1 fry fry 34520 Aug 30 14:16 LICENSE
-rw-r--r-- 1 fry fry  1178 Aug 30 14:16 README.md

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ục config/. 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 Toolkit.

​

Bố cục kho mã

Tên	Mô tả
bin	Thư mục này chứa một tập hợp các script giúp bạn quản lý phiên bản máy chủ Overleaf của mình. Bạn có thể đọc thêm về các script này trong phần Lệnh bên dưới.
config	Thư mục này chứa các tệp cấu hình cục bộ của riêng bạn.
lib	Thư mục này chứa các tệp cấu hình cơ sở được Toolkit sử dụng.
data	Theo mặc định, thư mục này là nơi lưu trữ dữ liệu của MongoDb, Redis và Overleaf. Để biết thêm thông tin, hãy xem phần Dữ liệu lưu trữ bền vững bên dưới.

Chúng tôi khuyến nghị không thay đổi trực tiếp các tệp nằm ngoài thư mục /config. Thay vào đó, nếu cần thay đổi, bạn có thể thực hiện thông qua các biến môi trường được đặt trong config/variables.env hoặc config/overleaf.rc.
Ví dụ, để đặt image cho dịch vụ mongo, thay vì chỉnh sửa trực tiếp lib/docker-compose.mongo.yml, hãy đặt image bằng biến môi trường MONGO_IMAGE trong config/overleaf.rc. Để biết thêm thông tin, hãy xem trang Thiết lập Toolkit.

Toolkit sẽ không thay đổi bất kỳ dữ liệu nào trong thư mục config/ nếu không có sự cho phép của bạn.

​

Các lệnh

Hãy chạy các script này từ thư mục Toolkit. Mỗi script sẽ in ra các tùy chọn của nó khi dùng --help.

Lệnh	Chức năng
bin/init	Tạo các tệp cấu hình trong config/ ở lần đầu tiên. bin/init --tls thêm cấu hình NGINX TLS proxy.
bin/up	Tạo và khởi động các container (bin/docker-compose up). Thêm -d để chạy ở chế độ nền thay vì theo dõi log. Hãy chạy lệnh này sau mỗi lần thay đổi trong config/: nó tạo lại các container có cấu hình thay đổi.
bin/start	Khởi động lại các container hiện có (bin/docker-compose start). Lệnh này không áp dụng các thay đổi cấu hình.
bin/stop	Dừng các container và giữ chúng lại (bin/docker-compose stop).
bin/docker-compose	Chạy docker compose với các tệp của Toolkit, ví dụ bin/docker-compose ps hoặc bin/docker-compose restart sharelatex.
bin/logs	Hiển thị hoặc theo dõi log của một hoặc nhiều dịch vụ, ví dụ bin/logs -f web.
bin/error-logs	Giống bin/logs, nhưng chỉ hiển thị các lỗi.
bin/shell	Mở một shell bên trong container sharelatex.
bin/mongo	Mở một MongoDB shell trên cơ sở dữ liệu sharelatex.
bin/run-script	Chạy một script có sẵn bên trong container sharelatex.
bin/doctor	Kiểm tra máy chủ host và cấu hình, rồi in ra một báo cáo để chia sẻ khi bạn cần trợ giúp.
bin/images	Liệt kê các Docker image của Overleaf trên máy chủ host.
bin/backup-config	Sao chép thư mục config/ tới một vị trí sao lưu (copy, zip hoặc tar).
bin/upgrade	Cập nhật Toolkit và image Overleaf từng bước, xem Nâng cấp bản triển khai của bạn.
bin/rename-env-vars-5-0, bin/rename-rc-vars	Các bước di chuyển một lần từ tên biến cũ SHARELATEX_* sang OVERLEAF_*.

Khi bin/up tạo lại một container, mọi thay đổi bên trong container đó sẽ bị mất, ví dụ các gói đã cài đặt hoặc các tệp đã chỉnh sửa thông qua bin/shell. Chỉ các thư mục dữ liệu (mặc định là data/) và config/ được giữ lại. Thay vào đó, hãy thực hiện các thay đổi lâu dài thông qua config/variables.env, config/overleaf.rc hoặc config/docker-compose.override.yml.

Nếu mỗi lần bin/up đều đăng xuất tất cả người dùng, hãy đặt OVERLEAF_SESSION_SECRET. Khi không có biến này, các cookie phiên được ký bằng một secret được tạo lại mỗi khi container được tạo lại, xem phần Hỏi & Đáp trong Biến môi trường.