Files

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

70 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

<p align="center">
<img src="https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png" width="80" alt="Stirling PDF logo">
</p>
2023-02-04 15:06:27 +00:00
<h1 align="center">Stirling PDF - The Open-Source PDF Platform</h1>
2023-01-27 18:23:40 +00:00
Stirling PDF is a powerful, open-source PDF editing platform. Run it as a personal desktop app, in the browser, or deploy it on your own servers with a private API. Edit, sign, redact, convert, and automate PDFs without sending documents to external services.
2023-07-29 14:31:09 +01:00
<p align="center">
<a href="https://hub.docker.com/r/stirlingtools/stirling-pdf">
<img src="https://img.shields.io/docker/pulls/frooodle/s-pdf" alt="Docker Pulls">
</a>
<a href="https://discord.gg/HYmhKj45pU">
<img src="https://img.shields.io/discord/1068636748814483718?label=Discord" alt="Discord">
</a>
<a href="https://scorecard.dev/viewer/?uri=github.com/Stirling-Tools/Stirling-PDF">
<img src="https://api.scorecard.dev/projects/github.com/Stirling-Tools/Stirling-PDF/badge" alt="OpenSSF Scorecard">
</a>
<a href="https://github.com/Stirling-Tools/stirling-pdf">
<img src="https://img.shields.io/github/stars/stirling-tools/stirling-pdf?style=social" alt="GitHub Repo stars">
</a>
</p>
2023-01-30 21:46:38 +00:00
![Stirling PDF - Dashboard](images/home-light.png)
2023-05-17 18:16:39 +01:00
## Key Capabilities
2024-12-30 15:49:28 +00:00
- **Everywhere you work** - Desktop client, browser UI, and self-hosted server with a private API.
- **50+ PDF tools** - Edit, merge, split, sign, redact, convert, OCR, compress, and more.
- **Automation & workflows** - No-code pipelines direct in UI with APIs to process millions of PDFs.
- **Enterprisegrade** - SSO, auditing, and flexible onprem deployments.
- **Developer platform** - REST APIs available for nearly all tools to integrate into your existing systems.
- **Global UI** - Interface available in 40+ languages.
2024-12-30 15:49:28 +00:00
For a full feature list, see the docs: **https://docs.stirlingpdf.com**
2023-09-14 13:35:33 +01:00
## Quick Start
2024-04-04 11:16:10 +02:00
```bash
docker run -p 8080:8080 docker.stirlingpdf.com/stirlingtools/stirling-pdf
```
2023-09-14 13:35:33 +01:00
Then open: http://localhost:8080
2023-01-30 20:50:47 +00:00
For full installation options (including desktop and Kubernetes), see our [Documentation Guide](https://docs.stirlingpdf.com/#documentation-guide).
2024-04-04 11:16:10 +02:00
## Resources
2023-09-14 13:32:49 +01:00
- [**Documentation**](https://docs.stirlingpdf.com)
- [**Homepage**](https://stirling.com)
- [**API Docs**](https://registry.scalar.com/@stirlingpdf/apis/stirling-pdf-processing-api/)
- [**Server Plan & Enterprise**](https://docs.stirlingpdf.com/Paid-Offerings)
2024-04-04 11:16:10 +02:00
## Support
2023-09-14 13:32:49 +01:00
- **Community**: [Discord](https://discord.gg/HYmhKj45pU)
- **Bug Reports**: [GitHub Issues](https://github.com/Stirling-Tools/Stirling-PDF/issues)
2024-04-04 11:16:10 +02:00
## Contributing
2023-09-14 13:32:49 +01:00
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
2024-04-04 11:16:10 +02:00
This project uses [Task](https://taskfile.dev/) as a unified command runner for all build, dev, and test commands. Run `task dev` to get started running the editor, run `task` to see the most common commands, or see the [Developer Guide](DeveloperGuide.md) for full details.
2023-09-14 13:32:49 +01:00
For adding translations, see the [Translation Guide](devGuide/HowToAddNewLanguage.md).
2024-06-19 21:05:56 +01:00
## License
2023-05-06 17:21:02 +01:00
Stirling PDF is open-core. See [LICENSE](LICENSE) for details.