Add PDF Processing to Your Self-Hosted n8n Workflows

Share this page

Run PDF workflows in your environment

Configure pdfRest automation with little or no code in your own n8n environment. Connect PDF processing to your applications without writing a custom API integration, while your team manages the workflow host.

Why choose self-hosted n8n?

Choose self-hosted n8n for private network access and control over updates, storage, and backups. Use a private pdfRest deployment for processing inside your network, or connect pdfRest Cloud.

Your team maintains the host. Prefer managed hosting? Use n8n Cloud.

Before you start

A running n8n instance and an owner or admin account, or a local test environment prepared below.
A pdfRest Cloud API key or the URL of your deployed pdfRest service.
Network access from n8n to that endpoint, plus credentials for your source and destination systems.
For the Google Drive example, have a working Google Drive credential or access to an administrator who can configure one.

Operation availability and usage depend on your pdfRest deployment and plan. Cloud Starter and Container Trial apply watermarks or, for some output types, text redactions. Compare pdfRest plans.

Prepare your n8n instance

If n8n is already running, continue to node installation. These alternatives start a local test instance; choose one.

Run a local n8n instance with Docker

Install and start Docker. Open your terminal and run:

docker volume create pdfrest_n8n_data
docker run -d --name pdfrest-n8n -p 127.0.0.1:5678:5678 -e GENERIC_TIMEZONE=Etc/UTC -e TZ=Etc/UTC -e N8N_ENFORCE_SETTINGS_FILE_PERMISSIONS=true -v pdfrest_n8n_data:/home/node/.n8n n8nio/n8n

Open http://localhost:5678 and complete the initial account setup. The volume retains the instance data across restarts. Replace both timezone values if schedules should use your local timezone. Run the creation command once; stop and restart the existing container with:

docker stop pdfrest-n8n
docker start pdfrest-n8n

If startup fails, run docker logs --tail 50 pdfrest-n8n. This local example binds the editor to your computer. Your computer and Docker must remain running. For a maintained deployment, follow n8n’s current deployment guidance. Running n8n in Docker does not also deploy pdfRest.

Run a local n8n instance directly

Use this option only with an n8n release that still supports direct installation. n8n has deprecated this method for newer releases; prefer Docker for a new deployment. Install a runtime supported by both your n8n release and the pdfRest node, then open your terminal and run:

npx n8n

Complete any installation prompt, open http://localhost:5678, and set up your account. Keep the terminal open while n8n runs. Stop with Ctrl+C and return by running the same command under the same operating-system account. See n8n’s direct-installation guide for current prerequisites.

Install pdfRest API Toolkit

Sign in to n8n as an owner or admin.
Open Settings → Community Nodes → Install.
Enter @pdfrest/n8n-nodes-pdfrest, review the installation prompts, and select Install.
Return to your workflow, search for pdfRest in the nodes panel, and add pdfRest API Toolkit.

Where verified-node discovery is enabled, you can also install through the nodes panel. For installation controls and updates, see n8n’s community-node management guide.

Connect your pdfRest deployment

Create a pdfRest API credential and choose where processing happens.

pdfRest Cloud

Create an account, get your API key from the dashboard, and select the US or EU endpoint. Save the key in your n8n credential.

Container or AWS

Select Self-Hosted or Container Deployment and enter a reachable Deployment URL. Configure licensing in pdfRest; this option does not require a Cloud API key.

Endpoint values and deployment instructions

Use pdfRest Cloud

Create a pdfRest account and get your API key from the account dashboard. In the pdfRest API Toolkit node, create a pdfRest API credential. Select the US (https://api.pdfrest.com) or EU (https://eu-api.pdfrest.com) API Base URL, enter your API key, and save the credential.

Use a self-hosted pdfRest deployment

Deploy pdfRest through Container or AWS. In the credential, select Self-Hosted or Container Deployment and enter its Deployment URL. This credential does not require an API key for self-hosted pdfRest; configure product licensing in the pdfRest deployment.

Keep Cloud API keys in n8n credentials rather than workflow exports or ordinary node fields. The selected endpoint receives the documents and parameters supplied to the node.

Choose an endpoint n8n can reach

Test the endpoint from the n8n host. Inside a container, localhost means that container.

Self-hosting n8n does not self-host pdfRest. A Cloud credential sends files to pdfRest Cloud; private processing requires a reachable private deployment. Review other connected services too.

Test a complete PDF workflow

Connect Google Drive first and create separate input and output folders. Need credentials? Follow the custom Google OAuth setup for the Drive API, OAuth client, and n8n redirect URL. Then test with a sample PDF.

Add a Manual Trigger and download a sample PDF with Google Drive. Confirm it produces binary file data.
Add pdfRest API Toolkit, select your credential, and choose Compress PDF.
Choose Input File and match its data field to the download, typically data. Choose your compression settings.
Enable Download Output Files and set its output data field to data.
Upload data to your separate output folder with a distinct filename.
Run the workflow and open the saved PDF. Check its content and file size.

Once this works, add a Google Drive trigger and map its file ID into the download node. Keep output outside the watched folder, test again, then activate.

Move from a local test to ongoing automation

Use an always-on host with persistent storage, backups, and a reachable HTTPS webhook address when needed. Test updates before rollout. Follow n8n’s deployment documentation for production hosting.

Troubleshoot the connection

The node is missing

Confirm the package installed successfully and that community nodes are enabled by your instance configuration. An owner or admin can review the installed package under Settings → Community Nodes.

Authentication or connection fails

For pdfRest Cloud, verify the selected endpoint, API key, plan, and usage allowance. For self-hosted pdfRest, check the Deployment URL, network access, and product licensing. Review the failed execution for the specific API response.

The next step has no PDF file

Confirm the input step downloaded the PDF as binary data and that the field name matches Input File Data Field Name. Turn on Download Output Files for the processing step, then match its output field in the upload step. Operations producing multiple files use suffixes such as data_1; check the actual output before mapping them.

Choose your next workflow

Start with a template, connect your accounts, and test with a sample document.

Prepare local PDFs for prepress

Watch a local folder and save separate PDF/X copies. Requires self-hosted n8n.

Get the prepress workflow

OCR and route email PDF attachments

Add OCR when needed and file PDFs in invoice, contract, or review folders in Google Drive.

Get the email OCR workflow

Create and review ZUGFeRD / Factur-X invoices

Create or validate a hybrid invoice, collect human approval, and download its review record.

Get the e-invoice workflow

Add PDF Processing to Your Self-Hosted n8n Workflows with pdfRest