-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
124 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,7 @@ | |
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
|
||
|
||
/.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
sidebar_position: 0 | ||
--- | ||
# The Technologies Behind Stirling PDF | ||
Stirling PDF harnesses several technologies throughout its implementation. | ||
|
||
# Java | ||
As part of the JAVA framework to host the WebUI itself we use Spring Boot and Thymeleaf. | ||
Apache PDFBox is the core of the PDF functionality within Stirling-PDF. | ||
They offer a variety of methods to edit PDFs which we have then built Stirling-PDF on. | ||
We also show all licenses used within our Java application [here](https://stirlingpdf.io/licenses). | ||
|
||
# JavaScript | ||
- [PDF.js](https://github.com/mozilla/pdf.js) | ||
- [PDF-LIB.js](https://github.com/Hopding/pdf-lib) | ||
|
||
# Core Components | ||
- [Spring Boot + Thymeleaf](https://spring.io/projects/spring-boot) for the web framework | ||
- [PDFBox](https://pdfbox.apache.org/) for majority of PDF manipulation | ||
- [qpdf](https://qpdf.sourceforge.io/) for some PDF operations | ||
- [LibreOffice](https://www.libreoffice.org/discover/libreoffice/) for advanced file conversions | ||
|
||
# Additional Technologies | ||
- HTML, CSS, JavaScript for the frontend | ||
- Docker for containerization | ||
- jcefmaven (specifically for portable non-server version) | ||
|
||
For a comprehensive list of all technologies within the java application and their licenses, please visit our [licenses page](https://stirlingpdf.io/licenses). |
2 changes: 1 addition & 1 deletion
2
...ted/Installation/Docker/Docker Install.md → docs/Installation/Docker Install.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ing started/Installation/Local/Windows.md → docs/Installation/Windows.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
# Getting Started with Stirling PDF | ||
|
||
Welcome to Stirling PDF! This guide will help you choose the right installation method based on your needs. | ||
We prioritise and focus on our Server deployment options however we also offer a [Ultra-Lite model](/Installation/Docker/Docker%20Versions) for desktop users | ||
|
||
## Choose Your Installation Type | ||
|
||
### For Desktop Users | ||
If you want to run Stirling PDF on your personal computer: | ||
|
||
1. **Windows Users** | ||
- Download our portable executable (Stirling-PDF.exe) for a simple, standalone experience | ||
- Refer to our [Windows Installation Guide](/Installation/Windows%20Installation) for detailed setup instructions | ||
- Note: A UI installer version is coming in the next release! | ||
|
||
2. **Linux/Unix Users** | ||
- Follow our comprehensive [Unix Installation Guide](/Installation/Unix%20Installation) for a native installation | ||
|
||
### For Server Deployments | ||
If you're looking to host Stirling PDF as a service: | ||
|
||
1. **Docker Users** | ||
- We recommend using our Docker images for the easiest deployment | ||
- Check our [Docker Installation Guide](/Installation/Docker/Docker%20Install) for setup instructions | ||
- Choose from three versions: | ||
- Fat (latest-fat): Includes additional fonts and security features | ||
- Standard (latest): Balanced features and size | ||
- Ultra-Lite (latest-ultra-lite): Minimal size with core features | ||
|
||
2. **Manual Server Setup** | ||
- For bare metal server installations | ||
- Use Stirling-PDF-Server package | ||
- Follow our [Unix Installation Guide](/Installation/Unix%20Installation) for setup steps | ||
|
||
## Quick Reference Table | ||
|
||
| Installation Type | Best For | Documentation Link | | ||
|------------------|----------|-------------------| | ||
| Stirling-PDF.exe | Windows desktop users | [Windows Guide](/Installation/Windows%20Installation) | | ||
| Stirling-PDF-Server | Server deployments without Docker | [Unix Guide](/Installation/Unix%20Installation) | | ||
| Docker Images | Server deployments with Docker | [Docker Guide](/Installation/Docker/Docker%20Install) | | ||
|
||
Choose the installation method that best suits your needs and environment. Each guide provides detailed instructions for getting Stirling PDF up and running on your system. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 1 | ||
sidebar_position: 0 | ||
slug: / | ||
--- | ||
|
||
|