https://github.com/ndolestudio/dompdf-api

Laravel API micro-service which to converts HTML to PDF.
https://github.com/ndolestudio/dompdf-api

html-to-pdf html-to-pdf-api html2pdf-api microservice pdf-generation

Last synced: about 1 month ago
JSON representation

Laravel API micro-service which to converts HTML to PDF.

• Host: GitHub
• URL: https://github.com/ndolestudio/dompdf-api
• Owner: NdoleStudio
• License: mit
• Created: 2022-12-14T15:50:39.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-01T11:54:30.000Z (about 1 month ago)
• Last Synced: 2024-12-01T12:37:30.667Z (about 1 month ago)
• Topics: html-to-pdf, html-to-pdf-api, html2pdf-api, microservice, pdf-generation
• Language: PHP
• Homepage:
• Size: 1.2 MB
• Stars: 25
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
dompdf API

==========

[![Build](https://github.com/NdoleStudio/dompdf-api/actions/workflows/ci.yml/badge.svg)](https://github.com/NdoleStudio/dompdf-api/actions/workflows/ci.yml)

[![GitHub contributors](https://img.shields.io/github/contributors/NdoleStudio/dompdf-api)](https://github.com/NdoleStudio/dompdf-api/graphs/contributors)

[![GitHub license](https://img.shields.io/github/license/NdoleStudio/dompdf-api?color=brightgreen)](https://github.com/NdoleStudio/dompdf-api/blob/master/LICENSE)

This project provides an HTTP API wrapper around the [dompdf](https://github.com/dompdf/dompdf) library which converts HTML to PDF. The API is created

using the Laravel framework, and you can protect the API using the [basic HTTP authentication scheme](https://datatracker.ietf.org/doc/html/rfc7617).

## Docker Setup

Run the docker container using the command below 

```bash

docker run -p 8000:80 ndolestudio/dompdf-api

```

Make an HTTP request to convert an HTML string into a PDF file called `document.pdf`

```bash

curl -X POST -d '
Hello World
' http://localhost:8000 --output document.pdf

```


## Authentication

If you want to protect the API with basic auth, you can set the `AUTH_USERNAME` and `AUTH_PASSWORD` environment variables when running the docker container

```bash

docker run -p 8000:80 \

      --env AUTH_USERNAME="username" \

      --env AUTH_PASSWORD="password" \

      ndolestudio/dompdf-api

```

**NOTE:** You must now set the username and password when making requests to the API

```bash

## username:password in base64 is dXNlcm5hbWU6cGFzc3dvcmQ=

curl  -X POST -d '
Hello World
' \

      -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \

      http://localhost:8000 --output document.pdf

```


## Security Vulnerabilities

If you discover a security vulnerability within the dompdf-api service, please send an e-mail to Acho Arnold via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

## License

dompdf-api is an open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).