Gotenberg APIを使用したHTMLからPDFへの変換 - n8n ワークフロー

自動ドキュメント生成のために、信頼性の高いセルフホスト型ソリューションを必要とする開発者。
既存のn8n環境に統合された、プライベートかつ大容量のPDF変換ツールを必要とするユーザー。
複雑なバイナリファイルの取り扱いや外部API連携を示す高度なn8nテンプレートを探している技術者。
n8nのセットアップにDockerを利用しており、他のコンテナ化されたサービスを活用したい方。

動的なHTMLコンテンツから高品質なPDFドキュメントを生成することは、オートメーションにおける一般的な課題です。多くのオンラインサービスが存在しますが、プライバシーに関する懸念やスケーラビリティの問題を引き起こすことがよくあります。この専門的なn8nワークフローテンプレートは、セルフホスト型のGotenbergサービスと直接統合することでこれを解決し、n8nインスタンスと安全に並行稼働させます。

このオートメーションは、プロフェッショナルなレポート、請求書、または複雑なドキュメントを作成するための、安全で高度にカスタマイズ可能な手段を提供します。ワークフローは、最初のn8nトリガーを通じてHTMLデータと希望する出力ファイル名を受け取り、内部でファイルの準備を行い、Gotenbergにリクエストを送信することで、効率的かつプライベートなPDF生成を保証します。このn8nオートメーションを習得することは、ドキュメントパイプラインに対する完全な制御を意味し、プロフェッショナルなシステムにとって極めて重要な機能となります。

このn8nワークフローは、手動で実行されるか、外部のWebhookまたはトリガーによって呼び出された際に開始され、HTMLコンテンツと希望のファイル名を期待します。

1. 入力トリガー: ワークフローはCreate PDF from HTMLというn8nトリガーノードで開始されます。このノードは、変換対象のhtmlコンテンツと、結果のPDFのfile_nameという2つの必須入力フィールドを想定するように設定されています。


2. ファイル準備: 処理はCreate index.htmlというn8nノードに進み、内部のconvertToFile関数を使用します。これは受信したhtml文字列を受け取り、index.htmlという名前のバイナリファイルに変換します。これはGotenberg APIにHTMLを適切にパッケージ化するために必要な手順です。


3. Gotenberg API呼び出し: 重要なステップは、Convert to PDF with Gotenbergというn8nノード（HTTPリクエストノード）で実行されます。このノードは、Gotenbergサービスに対してPOSTリクエスト（デフォルトではhttp://gotenberg:3000/forms/chromium/convert/html）を実行します。前のステップで準備されたバイナリファイルをmultipart-form-dataエンコーディングを使用して送信します。


4. メタデータのカスタマイズ: 極めて重要な点として、このn8nノードはリクエストボディ内にカスタマイズされたメタデータ（作成者、タイトル、作成日、キーワードなど）も渡します。また、n8nトリガーで定義された初期入力にリンクする式を使用して、出力ファイル名を動的に設定します。


5. 出力: Gotenbergは生成されたPDFドキュメントをバイナリ出力として返します。これは、後続のn8nノードを使用して保存したり、クラウドストレージにアップロードしたり、メールに添付したりできます。

このn8nワークフローテンプレートを正常にデプロイするには、次の手順に従ってください。

1. n8nワークフローのインポート: 提供されたJSONデータをコピーし、「新規作成」->「JSONからインポート」機能を使用してn8n環境に貼り付けます。


2. 前提条件: Gotenbergの設定: このワークフローは稼働中のGotenbergサービスを必要とします。最も簡単な方法は、n8nとGotenbergの両方が同じDockerネットワーク内で実行されていることを確認することです。一般的なDocker構成は以下の通りです。

gotenberg:
        image: gotenberg/gotenberg:8
        restart: always

1. API URLの設定: Convert to PDF with Gotenberg n8nノードでURLを確認します。Gotenbergサービスが標準のDockerネットワーク外や異なるポートでホストされている場合は、urlパラメータをhttp://gotenberg:3000/forms/chromium/convert/htmlからお客様固有のエンドポイントに更新する必要があります。


2. メタデータのカスタマイズ: Convert to PDF with Gotenberg n8nノードの「ボディパラメータ」を確認し、ニーズに合わせてAuthorやTitleなどのPDFメタデータを調整します。


3. テスト: Create PDF from HTML n8nトリガーを手動で実行し、PDFが正しく生成されることを確認します。

Create PDF from HTML (ワークフロー実行トリガー)
機能: ワークフローの開始点（n8nトリガー）として機能し、実行のためのサンプルデータを提供します。
主要な設定: 入力データは、htmlコンテンツと希望の出力file_nameで定義されます。

Create index.html (ファイルへの変換)
機能: 入力されたHTML文字列を保存可能なバイナリファイル（index.html）に変換します。Gotenbergは入力をファイルとして送信する必要があるため、このn8nノードは準備のために不可欠です。
主要な設定: operation: toText, sourceProperty: html, fileName: index.html。

Convert to PDF with Gotenberg (HTTPリクエスト)
機能: 準備されたバイナリHTMLファイルをセルフホスト型Gotenbergサービスに送信し、PDFドキュメントに変換します。これはn8nワークフロー全体の核となるアクションです。
主要な設定:
URL: http://gotenberg:3000/forms/chromium/convert/html (リモートサービスを使用する場合は調整が必要です)。
Content Type: multipart-form-data。
ボディパラメータ: カスタマイズのためにバイナリデータ入力と広範なJSON形式のPDFメタデータを含みます。
* ヘッダー: Gotenberg-Output-Filenameヘッダーを使用し、初期のn8nトリガー入力に基づいて最終的なPDF名を設定する動的な式が適用されます。