Run JPedal as a Java Web Service
JPedal can be deployed as a self-hosted microservice, exposing PDF processing operations over a REST API. The microservice runs headlessly with no display required and can be deployed on any cloud platform, application server, or Docker-compatible environment.
Requirements
| Requirement | Value |
|---|---|
| Minimum Java version | Java 17 |
| Third-party dependencies | None |
Host your own Docker Image
JPedal provides an open-source Docker image that wraps the microservice. It can be run locally or deployed to any container-compatible cloud platform.
How does the Docker image work?
Deploy on a Cloud Platform
Deployment guides are available for all major cloud platforms.
Deploy on Amazon Web Services (AWS)
Deploy on Microsoft Azure
Deploy on Google Cloud Platform (GCP)
Deploy on DigitalOcean
Deploy on Oracle Cloud Infrastructure
Deploy on an Application Server
JPedal can be deployed on standard Java application servers.
Deploy with Tomcat
Deploy with Jetty
Deploy with GlassFish
Deploy with Payara
Convert PDF to Image via REST API
The microservice exposes a REST endpoint for converting PDF pages to images. Client libraries are available for common languages.
Convert PDF to Image Web Service API
Extract Text via REST API
The microservice exposes a REST endpoint for extracting text from PDF files. Client libraries are available for common languages.
Text Extraction Web Service API
Extract Images via REST API
The microservice exposes a REST endpoint for extracting embedded images from PDF files. Client libraries are available for common languages.
Image Extraction Web Service API
Configuration
The microservice supports configuration of concurrency, memory limits, storage paths, file retention, remote storage, and more.
Web Service Configuration Options
Frequently Asked Questions
Can JPedal run as a web service?
Yes. JPedal provides a self-hosted microservice that exposes PDF processing operations over a REST API. It can be deployed on any cloud platform, application server, or Docker-compatible environment.
What cloud platforms does JPedal support?
The JPedal microservice can be deployed on AWS, Microsoft Azure, Google Cloud Platform, DigitalOcean and Oracle Cloud Infrastructure using Docker.
Can JPedal run headlessly without a display?
Yes. The JPedal microservice requires no display and is designed for server-side and headless deployments.
What application servers does JPedal support?
JPedal can be deployed on Tomcat, Jetty, GlassFish and Payara.
Can the JPedal REST API be called from non-Java languages?
Yes. Client libraries are available for Java, Python, C#, Node.js, JavaScript, PHP and Ruby. The API can also be called directly using any HTTP client, including cURL.
What operations does the JPedal microservice support?
The microservice supports converting PDF pages to images, extracting text from PDFs, and extracting embedded images from PDFs.
Can JPedal run in Docker?
Yes. JPedal provides an open-source Docker image that can be run locally or deployed to any container-compatible cloud or on-premises environment.
Does JPedal require any third-party dependencies to run as a web service?
No. JPedal has no required third-party Java dependencies, no native binaries and no external tools required.
What Java version is required?
JPedal requires Java 17 as a minimum. Details at Which Java versions does JPedal support?