Chuyển tới nội dung chính

Điều hướng

clmBot là một client nhẹ được triển khai trên máy chủ mạng nội bộ của bạn, dùng để tự động hoàn tất việc triển khai và gia hạn chứng chỉ SSL: lấy chứng chỉ mới nhất từ đám mây, ghi vào điểm cài đặt chứng chỉ trên máy chủ, và thực thi script theo cấu hình để tải lại dịch vụ middleware.

Cách thức hoạt động​

Quy trình gia hạn chứng chỉ của clmBot như sau:

  1. Trước khi chứng chỉ hết hạn, đám mây sẽ tự động hoàn tất việc cấp lại chứng chỉ và tạo chứng chỉ mới.
  2. clmBot nhận chứng chỉ mới nhất thông qua đẩy từ đám mây hoặc kéo theo lịch định kỳ.
  3. clmBot cố gắng sao lưu và thay thế tệp chứng chỉ cục bộ trên máy chủ; nếu sao lưu thất bại sẽ ghi lại lỗi nhưng không ngăn cản quá trình cập nhật tiếp theo.
  4. clmBot thực thi tập lệnh tải lại theo cấu hình (after_script); việc có hiệu lực hay không phụ thuộc vào kết quả thực thi tập lệnh và trạng thái middleware.

Toàn bộ quy trình không cần đăng nhập thủ công vào máy chủ để thay thế chứng chỉ, cũng không để lộ cổng quản trị của máy chủ ra bên ngoài.

Các phương thức cập nhật được hỗ trợ​

clmBot hỗ trợ hai phương thức gia hạn chứng chỉ, có thể lựa chọn riêng trên các máy chủ khác nhau:

Phương thức cập nhậtChế độ hoạt độngYêu cầu cổngTình huống áp dụng
Đẩy từ đám mâyKhởi tạo đẩy từ nền quản trị, dịch vụ clmBot trên máy chủ nhận và cập nhật chứng chỉCần mở cổng vào 8862/tcpChính sách mạng cho phép mở cổng vào, mong muốn cập nhật có hiệu lực ngay lập tức
Kéo theo lịchChạy clmBot định kỳ qua crontab hoặc Windows Task Scheduler, kiểm tra và kéo chứng chỉ mới nhấtKhông cần mở cổng vào, chỉ cần truy cập ra ngoài đến đám mâyMáy chủ không thể mở cổng vào (khuyến nghị mặc định)

Để biết phương pháp cấu hình chi tiết, vui lòng tham khảo Phương thức gia hạn chứng chỉ.

Nền tảng và middleware được hỗ trợ​

Hệ điều hành được hỗ trợ:

  • Linux (amd64, arm64)
  • macOS (amd64, arm64)
  • Windows (amd64; đối với Windows phiên bản cũ, sử dụng gói tương thích legacy)

Các middleware và định dạng chứng chỉ được hỗ trợ:

MiddlewareĐịnh dạng chứng chỉMô tả
nginxPEMTriển khai tách riêng chứng chỉ, chuỗi CA và khóa riêng
Apache HTTP ServerPEMTriển khai tách riêng chứng chỉ, chuỗi CA và khóa riêng
TomcatPEM / JKSHỗ trợ chứng chỉ PEM hoặc JKS keystore
IISIISNhập PFX qua tập lệnh tích hợp và cập nhật liên kết site, cần quyền quản trị viên
ExchangeExchangeChỉ hỗ trợ cập nhật; không hỗ trợ phát hiện, truy vấn hoặc sync-server, cần quyền quản trị viên
Khác (tập lệnh tùy chỉnh)PFX, v.v.Hỗ trợ mọi tình huống thông qua after_script tùy chỉnh

Cách chọn tài liệu​

Tình huống sử dụngTrang được đề xuất
Lần đầu sử dụng, muốn triển khai nhanh và hoàn tất một lần gia hạn chứng chỉBắt đầu nhanh
Tìm hiểu cấu hình chi tiết của hai phương thức gia hạnPhương thức gia hạn chứng chỉ
Thêm điểm cài đặt thủ công, đồng bộ điểm cài đặt từ backend, sử dụng trang cấu hình Web cục bộQuản lý điểm cài đặt
Xem ý nghĩa các trường trong config.yaml, biến mẫu scriptTham khảo cấu hình
Xem ví dụ đầy đủ về cài đặt và tải lại chứng chỉ cho các middleware như nginx, Apache, TomcatVí dụ cấu hình
Thắt chặt quyền chạy của clmBot trong môi trường production, cấu hình sudoersYêu cầu quyền chạy
Đăng ký clmBot làm dịch vụ hệ thống, nâng cấp phiên bản, xem nhật kýTriển khai dạng dịch vụ và nâng cấp

Bắt đầu nhanh​

Nếu bạn sử dụng clmBot lần đầu tiên, bạn nên làm theo các bước sau:

  1. Tạo AccessKey / AccessSecret trong trang quản trị.
  2. Tải xuống clmBot và tải lên máy chủ.
  3. Thực thi login để hoàn tất kết nối và kích hoạt node trong trang quản trị.
  4. Thực thi discover-certificate để tự động phát hiện chứng chỉ trên máy chủ.
  5. Cấu hình phương thức cập nhật (đẩy hoặc định kỳ kéo về).

Để biết các bước đầy đủ, vui lòng tham khảo Bắt đầu nhanh.