Bỏ qua để đến nội dung

Cài đặt NextPDF Connect

Cài đặt nextpdf/server bằng Composer. Sau đó, chạy một trong ba điểm vào cho transport. Bản cài đặt lõi chỉ yêu cầu PHP 8.4 và engine NextPDF. Redis và Premium là tùy chọn.

Terminal window
composer require nextpdf/server

Lệnh này cài đặt nextpdf/core: ^3.0. Gói này khai báo php: >=8.4 <9.0, nên Composer sẽ từ chối cài đặt trên PHP 8.3 trở xuống hoặc PHP 9.

Đây là gói Composer thuộc loại library. Khi cài đặt, gói sẽ thêm bốn điểm vào console trong vendor/bin/:

  • vendor/bin/nextpdf-mcp — máy chủ Model Context Protocol (MCP) qua stdio.
  • vendor/bin/nextpdf-server — máy chủ Representational State Transfer (REST) (RoadRunner HTTP worker).
  • vendor/bin/nextpdf-grpc — máy chủ gRPC (RoadRunner gRPC worker).
  • vendor/bin/generate-skills — xuất danh mục công cụ thành agent skills.

Một script thứ năm, bin/nextpdf-prune, đi kèm trong kho lưu trữ để phục vụ các tác vụ bảo trì. Hãy chạy trực tiếp script này thay vì qua vendor/bin/.

Bạn không cần service provider, bundle hay đăng ký framework. Máy chủ chạy như một tiến trình độc lập. Đây không phải là thư viện để tích hợp vào ứng dụng host.

Composer cũng cài đặt các phụ thuộc runtime của gói. Các phụ thuộc bắc cầu này bao gồm stack Hypertext Transfer Protocol (HTTP) và gRPC:

  • league/routenyholm/psr7 — định tuyến REST và thông điệp PHP Standard Recommendation (PSR)-7.
  • spiral/roadrunner-httpspiral/roadrunner-grpc — runtime worker RoadRunner cho các transport REST và gRPC.
  • psr/http-server-middlewarepsr/http-server-handler — các contract middleware PSR-15 mà pipeline REST hiện thực.
  • symfony/yaml — phân tích cú pháp tệp cấu hình.
  • ramsey/uuid — định danh request và tài nguyên.

Không cài đặt trực tiếp các gói này. Composer sẽ tự giải quyết chúng cho bạn từ nextpdf/server.

Để kiểm tra bản cài đặt, hãy liệt kê danh mục công cụ mà không khởi động máy chủ:

Terminal window
./vendor/bin/generate-skills --dry-run --list-tools

Lệnh này khởi động registry, chạy phát hiện tier và in ra các công cụ mà bản cài đặt này cung cấp. Danh sách này phản ánh các gói tùy chọn hiện có. Xem /connect/tool-catalog/.

Bản cài đặt production sẽ ghim các phụ thuộc và bỏ qua công cụ phát triển:

Terminal window
composer require nextpdf/server --no-dev
composer install --no-dev --optimize-autoloader --classmap-authoritative

Đối với các transport REST và gRPC, hãy cài đặt thêm RoadRunner binary. RoadRunner là trình giám sát tiến trình sở hữu nhóm worker. Gói PHP cung cấp worker, chứ không phải trình giám sát:

Terminal window
./vendor/bin/rr get-binary

Trường hợp đặc biệt và điểm cần lưu ý

Phần tiêu đề “Trường hợp đặc biệt và điểm cần lưu ý”
  • Redis tùy chọn. Phần mở rộng ext-redis là một suggest, không phải là một require. Không có nó, máy chủ REST sử dụng các kho lưu trữ trong bộ nhớ cho giới hạn tốc độ, idempotency và tài liệu. Các kho lưu trữ trong bộ nhớ đó hoạt động đúng với một worker đơn, nhưng không được chia sẻ trên một nhóm nhiều worker. Đối với các triển khai nhiều worker, hãy cài đặt ext-redis và thiết lập các biến môi trường Redis. Xem /connect/configuration/.

  • Premium tùy chọn. nextpdf/premium là một suggest. Khi bạn cài đặt nó cùng với máy chủ, các probe phát hiện tier của registry sẽ tìm thấy các lớp provider của nó và đăng ký thêm các công cụ Pro và Enterprise. Không có nó, máy chủ chỉ phục vụ danh mục lõi. Đây là quyết định đóng gói được đưa ra tại thời điểm composer require, không phải là một công tắc bật/tắt lúc chạy.

  • Máy chủ MCP không cần RoadRunner. nextpdf-mcp là một tiến trình PHP thuần túy giao tiếp bằng JavaScript Object Notation Remote Procedure Call (JSON-RPC) qua đầu vào và đầu ra chuẩn (stdio). RoadRunner chỉ bắt buộc đối với các transport REST và gRPC.

Quá trình giải quyết phụ thuộc của Composer chiếm phần lớn chi phí ở thời điểm cài đặt. Trong các image production, hãy dùng --prefer-dist và một classmap có thẩm quyền để giữ thời gian autoload lúc khởi động nguội ở mức thấp. Chi phí khởi động riêng của máy chủ đến từ việc quét registry và phát hiện tier. Giá trị performance_budget trên trang này giới hạn chi phí khởi động đó.

Chỉ cài đặt từ gói Packagist chính thức nextpdf/server. Hãy ghim phiên bản trong composer.json và commit composer.lock để danh mục công cụ đã triển khai có thể tái lập. Các transport qua mạng yêu cầu một khóa application programming interface (API) trước khi phục vụ bất kỳ endpoint nào không phải health; xem /connect/security-and-operations/.

Trang này chỉ mô tả cơ chế cài đặt. Các trích dẫn về tuân thủ giao thức và bảo mật được ghim tại /transports/mcp/, /transports/rest/, /transports/grpc/, và /connect/security-and-operations/.

Bản cài đặt lõi hoạt động đầy đủ chức năng. Nó xử lý việc tạo tài liệu, kiểm tra và chẩn đoán trên cả ba transport. Việc thêm nextpdf/premium mở rộng danh mục mà không thay đổi mô hình transport hay xác thực.

  • /connect/overview/ — gói này cung cấp những gì
  • /connect/quickstart/ — lần tương tác chạy được đầu tiên
  • /connect/configuration/ — các biến môi trường và tệp cấu hình
  • /connect/deployment/ — triển khai RoadRunner, Docker và transport kết hợp
  • /connect/tool-catalog/ — bản cài đặt này cung cấp những công cụ nào