mirror of
https://github.com/gotenberg/gotenberg.git
synced 2026-08-08 00:22:14 +01:00
72 lines
3.1 KiB
Markdown
72 lines
3.1 KiB
Markdown
<p align="center">
|
|
<img src="https://user-images.githubusercontent.com/8983173/130322857-185831e2-f041-46eb-a17f-0a69d066c4e5.png" alt="Gotenberg Logo" width="150" height="150" />
|
|
<h3 align="center">Gotenberg</h3>
|
|
<p align="center">A Docker-based API for converting documents to PDF</p>
|
|
<p align="center">
|
|
<a href="https://hub.docker.com/r/gotenberg/gotenberg"><img alt="Total downloads (gotenberg/gotenberg)" src="https://img.shields.io/docker/pulls/gotenberg/gotenberg"></a>
|
|
<a href="https://github.com/gotenberg/gotenberg/actions/workflows/continuous-integration.yml"><img alt="Continuous Integration" src="https://github.com/gotenberg/gotenberg/actions/workflows/continuous-integration.yml/badge.svg"></a>
|
|
<a href="https://pkg.go.dev/github.com/gotenberg/gotenberg/v8"><img alt="Go Reference" src="https://pkg.go.dev/badge/github.com/gotenberg/gotenberg.svg"></a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://trendshift.io/repositories/2996"><img src="https://trendshift.io/api/badge/repositories/2996" alt="gotenberg%2Fgotenberg | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://gotenberg.dev/docs/getting-started/introduction"><strong>Documentation</strong></a> ·
|
|
<a href="https://gotenberg.dev/docs/getting-started/installation#live-demo"><strong>Live Demo</strong></a> ·
|
|
<a href="https://github.com/gotenberg/gotenberg/discussions"><strong>Community</strong></a>
|
|
</p>
|
|
</p>
|
|
|
|
---
|
|
|
|
**Gotenberg** is a Docker-based API for converting documents to PDF. Trusted in production by thousands of companies. Also adopted by notable open-source projects.
|
|
|
|
Send your files via `multipart/form-data`, get a PDF back. No need to manage Chromium, LibreOffice, or fonts yourself.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
docker run --rm -p 3000:3000 gotenberg/gotenberg:8
|
|
```
|
|
|
|
Convert a URL to PDF:
|
|
|
|
```bash
|
|
curl \
|
|
--request POST http://localhost:3000/forms/chromium/convert/url \
|
|
--form url=https://sparksuite.github.io/simple-html-invoice-template/ \
|
|
-o invoice.pdf
|
|
```
|
|
|
|
## Features
|
|
|
|
- **HTML, URL, Markdown to PDF** via Headless Chromium
|
|
- **Office documents to PDF** via LibreOffice (100+ formats)
|
|
- **Merge, split, rotate, flatten** PDFs
|
|
- **Watermark, stamp, encrypt** PDFs
|
|
- **PDF/A and PDF/UA** compliance
|
|
- **Screenshots** of URLs and HTML
|
|
- **Read/write metadata and bookmarks**
|
|
|
|
See the [full documentation](https://gotenberg.dev/docs/getting-started/introduction).
|
|
|
|
## Contributing
|
|
|
|
Questions and feedback: [GitHub Discussions](https://github.com/gotenberg/gotenberg/discussions).
|
|
Bug reports: [GitHub Issues](https://github.com/gotenberg/gotenberg/issues).
|
|
|
|
## Sponsors
|
|
|
|
If Gotenberg powers your workflow or your business, consider [**becoming a sponsor**](https://github.com/sponsors/gulien).
|
|
|
|
**Historic & GitHub Sponsors**
|
|
|
|
- [TheCodingMachine](https://thecodingmachine.com/)
|
|
- [pdfme](https://pdfme.com/)
|
|
- [PDFBolt](https://pdfbolt.com)
|
|
|
|
**Powered By**
|
|
|
|
- [Docker](https://docs.docker.com/docker-hub/repos/manage/trusted-content/dsos-program/)
|
|
- [JetBrains](https://www.jetbrains.com/community/opensource/)
|