跳到內容

安裝 NextPDF

每一個 NextPDF 發行版都只需要一行套件管理器指令即可安裝。PHP 發行版使用 Composer;Python SDK 則使用 pip。選擇符合需求的分頁,執行該指令,再用本頁底部的驗證步驟確認結果。

NextPDF 只鎖定單一現代執行環境。下列限制條件直接來自各套件本身的 composer.json 檔案。

需求項目限制條件說明
PHP>=8.4 <9.0在 PHP 8.3 以下或 PHP 9 上,Composer 會拒絕安裝。
Composer(套件管理器)2.7 或更新版本相依套件 resolve(解析)器與 autoloader 產生器。
ext-mbstring必要用於文字排版的多位元組字串處理。
ext-zlib必要用於 PDF 物件的串流壓縮。
Chrome 或 Chromium選用僅用於 Artisan renderer(渲染器)(writeHtmlChrome())。
Gotenberg 服務選用僅用於透過 Gotenberg 進行 Office 與 HTML 轉換。
Python(程式語言)3.10 或更新版本僅用於 Python SDK。

ext-mbstringext-zlib 在每一個受支援的 PHP 組建中都預設啟用。整合套件會在啟動時檢查它們;若缺少其中任一個,就會以清楚的訊息停止。

如果你只需要用 PHP 產生與檢視 PDF,核心引擎就是唯一需要的套件。

Terminal window
composer require nextpdf/core

請提交 composer.lock,讓每一個部署的 worker 都解析到相同的引擎版本。安裝完成後,請接著前往 你的第一份 PDF

安裝 framework 轉接器後,即可取得容器繫結、回應輔助方法與佇列工作。每個轉接器都會宣告 nextpdf/core,並替你完成解析。

Terminal window
composer require nextpdf/laravel

自動探索會註冊服務提供者與 Pdf facade。接著發布組態檔:

Terminal window
php artisan vendor:publish --tag=nextpdf-config

請參閱 Laravel 安裝指南Laravel 快速入門

NextPDF 提供三種把 HTML 算繪成 PDF 的方式。請依你希望算繪發生的位置,安裝對應的套件。這些都不會取代 writeHtml(),也就是核心引擎內建的純 PHP HTML 管線。

Terminal window
composer require nextpdf/artisan

透過 Chrome DevTools Protocol(CDP)加入 headless Chrome 算繪。主機上還需要有一個可存取的 Chrome 或 Chromium 執行檔。安裝完成後,在文件物件上呼叫 writeHtmlChrome()。請參閱 Artisan 快速入門

NextPDF Server(也稱為 Connect)是一個獨立的服務。 它透過 MCP、REST 與 gRPC 對外公開引擎功能。

Terminal window
composer require nextpdf/server

這個套件會在 vendor/bin/ 加入主控台進入點,包括 vendor/bin/nextpdf-mcp(MCP stdio 伺服器)與 vendor/bin/nextpdf-server(REST 伺服器)。REST 與 gRPC 傳輸還需要 RoadRunner 執行檔:

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

請參閱 Connect 安裝指南Connect 快速入門

Python SDK 是一個型別化的用戶端,用來對接執行中的 NextPDF Server。請從 PyPI 安裝它:

Terminal window
pip install nextpdf

這個 SDK 需要 Python 3.10 或更新版本,以及一個可存取的 NextPDF Server endpoint。請參閱 Python SDK 快速入門

開始寫程式碼之前,先確認每一個發行版都已正確解析。

Terminal window
composer show nextpdf/core

若出現版本資訊那一行,就代表引擎已安裝並掛上 autoloader。