Skip to content

Pitue/gotenberg-interface

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

Gotenberg Interface

A browser-based UI for exercising a Gotenberg instance interactively — pick an endpoint, fill in parameters, send the request, preview the response, and validate the result against PDF/UA and WCAG accessibility rules.

Repository layout

Path Purpose
gotenberg-interface/ The React + Vite SPA, Dockerfile, and nginx config. See its README.
docs/ Architecture and conformance docs. Start with overview.md.

Quick start

From this directory:

cd gotenberg-interface
docker compose up --build

Then open http://localhost:8081. This brings up the UI, a Gotenberg instance (port 3000), and a veraPDF instance (port 8080) on one network.

To point the UI at external services, create a .env next to gotenberg-interface/docker-compose.yml:

GOTENBERG_URL=http://my-gotenberg.internal:3000
VERAPDF_URL=http://my-verapdf.internal:8080

Local development

cd gotenberg-interface
pnpm install
pnpm dev

Dev mode proxies /gotenberg/* and /verapdf/* to the URLs in .env (defaults: http://localhost:3000 and http://localhost:8080).

What you can do

  • Browse every Gotenberg endpoint (Chromium, LibreOffice, PDF Engines, Webhooks, Health) with auto-generated forms.
  • Send mixed file + form-data requests and preview the response inline (PDF viewer, image, or pretty-printed JSON/text).
  • Validate generated PDFs against PDF/A and PDF/UA-1 via veraPDF.
  • Run axe-core over HTML inputs before conversion to flag WCAG 2.1 A/AA issues.

Stack

  • React 19 + TypeScript + Vite 8 (rolldown), Tailwind CSS v4, react-compiler
  • nginx + envsubst for production-time config

Further reading

About

Simple UI for interacting with the Gotenberg API including PDF format validation via veraPDF.

Topics

Resources

Stars

Watchers

Forks

Contributors

Languages