--- title: "Deploy pdf-renderer" description: "Deploy a backend service to render PDFs from supplied html/css." category: "Other" url: https://railway.com/deploy/pdf-renderer --- # Deploy pdf-renderer Deploy a backend service to render PDFs from supplied html/css. **[Deploy pdf-renderer on Railway](https://railway.com/template/pdf-renderer)** - **Creator:** Fr. Andrew Hedstrom's Projects - **Category:** Other ## Template content ### pdf-renderer - **Source:** protoapostoli/pdf-renderer ## Documentation # Deploy and Host PDF Renderer runs as a background service with url access via public and or private network. Supporting ipv4 and ipv6. Uses playwright, NPM, and headless chromium to accomplish its task. ## About Hosting pdf-renderer Just need to load it into railway, add a token variable, and fire away. Dockerfile takes care of everything else. ## Common Use Cases - Writing CSS and rendering it in PDF. Replaces DomPDF as background PDF generator. ## Dependencies for pdf-renderer Hosting - Playwright - NPM - Chromium ### Implementation Details Variable pdf-renderer.RENDERER_TOKEN pdf-renderer.RENDERER_TOKEN . You need to randomly generate a token for security. # PDF Renderer Service Integration Guide The **PDF Renderer** is a serverless microservice powered by headless Chromium/Playwright. It converts complete HTML/CSS markup into print-ready PDF documents via a single HTTP POST request. --- ## 1. HTTP Endpoint Specification | Property | Value | | :--- | :--- | | **Method** | `POST` | | **Endpoint** | `https:///render` | | **Headers** | `Authorization: Bearer `
`Content-Type: application/json`
`Accept: application/pdf` | | **Response** | `200 OK` with raw `application/pdf` binary stream | --- ## 2. JSON Request Payload ```json { "html": "

Certificate

", "options": { "printBackground": true, "preferCSSPageSize": true, "format": "Letter", "landscape": false } } ``` ### Available Options | Option | Type | Default | Description | | :--- | :--- | :--- | :--- | | `printBackground` | `boolean` | `true` | Renders background colors, CSS gradients, and box borders. | | `preferCSSPageSize` | `boolean` | `true` | Prioritizes `@page { size: ... }` defined directly in the CSS. | | `format` | `string` | `"Letter"` | Standard paper formats: `"Letter"`, `"Legal"`, `"A4"`. | | `landscape` | `boolean` | `false` | Rotates layout to landscape orientation. | | `width` / `height` | `string` | — | Custom page dimensions (e.g., `"9.5in"` & `"4.125in"` for #10 envelopes). | --- ## 3. HTML & CSS Guidelines 1. **Self-Contained Styles**: Place all CSS inside `