mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2026-02-17 13:52:14 +01:00
a53d73ef51
# Description of Changes <!-- Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --> --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.
70 lines
2.9 KiB
Markdown
70 lines
2.9 KiB
Markdown
<p align="center">
|
||
<img src="https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png" width="80" alt="Stirling PDF logo">
|
||
</p>
|
||
|
||
<h1 align="center">Stirling PDF - The Open-Source PDF Platform</h1>
|
||
|
||
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 third‑party services.
|
||
|
||
<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>
|
||
|
||
|
||
|
||
## Key Capabilities
|
||
|
||
- **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.
|
||
- **Enterprise‑grade** - SSO, auditing, and flexible on‑prem deployments.
|
||
- **Developer platform** - REST APIs available for nearly all tools to integrate into your existing systems.
|
||
- **Global UI** - Interface available in 40+ languages.
|
||
|
||
For a full feature list, see the docs: **https://docs.stirlingpdf.com**
|
||
|
||
## Quick Start
|
||
|
||
```bash
|
||
docker run -p 8080:8080 docker.stirlingpdf.com/stirlingtools/stirling-pdf
|
||
```
|
||
|
||
Then open: http://localhost:8080
|
||
|
||
For full installation options (including desktop and Kubernetes), see our [Documentation Guide](https://docs.stirlingpdf.com/#documentation-guide).
|
||
|
||
## Resources
|
||
|
||
- [**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)
|
||
|
||
## Support
|
||
|
||
- **Community** [Discord](https://discord.gg/HYmhKj45pU)
|
||
- **Bug Reports**: [Github issues](https://github.com/Stirling-Tools/Stirling-PDF/issues)
|
||
|
||
## Contributing
|
||
|
||
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||
|
||
For development setup, see the [Developer Guide](DeveloperGuide.md).
|
||
|
||
For adding translations, see the [Translation Guide](devGuide/HowToAddNewLanguage.md).
|
||
|
||
## License
|
||
|
||
Stirling PDF is open-core. See [LICENSE](LICENSE) for details.
|