| sidebar_position | 2 |
|---|---|
| id | Unix Installation |
| title | Unix Installation Guide |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
To run the application without Docker/Podman, you will need to manually install all dependencies and build the necessary components.
Note that some dependencies might not be available in the standard repositories of all Linux distributions, and may require additional steps to install.
The following guide assumes you have a basic understanding of using a command line interface in your operating system.
It should work on most Linux distributions and MacOS. For Windows, you might need to use Windows Subsystem for Linux (WSL) for certain steps. The amount of dependencies is to actually reduce overall size, ie installing LibreOffice sub components rather than full LibreOffice package.
You could theoretically use a Distrobox/Toolbox, if your Distribution has old or not all Packages. But you might just as well use the Docker Container then.
Install the following software, if not already installed:
- Java 17 or later (21 recommended)
- Gradle 7.0 or later (included within repo so not needed on server)
- Git
- Python 3.8 (with pip)
- Make
- GCC/G++
- Automake
- Autoconf
- libtool
- pkg-config
- zlib1g-dev
- libleptonica-dev
Next we need to install LibreOffice for conversions, tesseract for OCR, and opencv for pattern recognition functionality.
Install the following software:
- libreoffice (libreoffice-core libreoffice-common libreoffice-writer libreoffice-calc libreoffice-impress)
- python3-uno
- unoserver
- pngquant
- tesseract
- opencv-python-headless
The JAR can be downloaded in two versions, normal and security
You can move this file to a desired location, for example, /opt/Stirling-PDF/.
You must also move the Script folder within the Stirling-PDF repo that you have downloaded to this directory.
This folder is required for the python scripts using OpenCV.
If you plan to use the OCR (Optical Character Recognition) functionality, you might need to install language packs for Tesseract if running non-english scanning.
```bash sudo apt update &&\ # All languages # sudo apt install -y 'tesseract-ocr-*'# Find languages:
apt search tesseract-ocr-
# View installed languages:
dpkg-query -W tesseract-ocr- | sed 's/tesseract-ocr-//g'
```
# Find languages:
dnf search -C tesseract-langpack-
# View installed languages:
rpm -qa | grep tesseract-langpack | sed 's/tesseract-langpack-//g'
```
**IMPORTANT:** DO NOT REMOVE EXISTING `eng.traineddata`, IT'S REQUIRED.
This will add a modified Appstarter to your Appmenu.
location=$(pwd)/gradlew
image=$(pwd)/docs/stirling-transparent.svg
cat > ~/.local/share/applications/Stirling-PDF.desktop <<EOF
[Desktop Entry]
Name=Stirling PDF;
GenericName=Launch StirlingPDF and open its WebGUI;
Category=Office;
Exec=xdg-open http://localhost:8080 && nohup $location java -jar /opt/Stirling-PDF/Stirling-PDF-*.jar &;
Icon=$image;
Keywords=pdf;
Type=Application;
NoDisplay=false;
Terminal=true;
EOFNote: Currently the app will run in the background until manually closed.
To override the default configuration, you can add the following to /.git/Stirling-PDF/configs/custom_settings.yml file:
server:
host: 0.0.0.0
port: 3000For systemd add in the .env file (see run as service for setting environment variables):
SERVER_HOST="0.0.0.0"
SERVER_PORT="3000"Note: The file custom_settings.yml is created after the first application launch. To have it before that, you can create the directory and add the file yourself.
First create a .env file, where you can store environment variables:
touch /opt/Stirling-PDF/.env
In this file you can add all variables, one variable per line, as stated in the main readme (for example SYSTEM_DEFAULTLOCALE="de-DE").
Create a new file where we store our service settings and open it with nano editor:
nano /etc/systemd/system/stirlingpdf.service
Paste this content, make sure to update the filename of the jar-file. Press Ctrl+S and Ctrl+X to save and exit the nano editor:
[Unit]
Description=Stirling-PDF service
After=syslog.target network.target
[Service]
SuccessExitStatus=143
User=root
Group=root
Type=simple
EnvironmentFile=/opt/Stirling-PDF/.env
WorkingDirectory=/opt/Stirling-PDF
ExecStart=/usr/bin/java -jar Stirling-PDF-0.17.2.jar
ExecStop=/bin/kill -15 $MAINPID
[Install]
WantedBy=multi-user.target
Notify systemd that it has to rebuild its internal service database (you have to run this command every time you make a change in the service file):
sudo systemctl daemon-reload
Enable the service to tell the service to start it automatically:
sudo systemctl enable stirlingpdf.service
See the status of the service:
sudo systemctl status stirlingpdf.service
Manually start/stop/restart the service:
sudo systemctl start stirlingpdf.service
sudo systemctl stop stirlingpdf.service
sudo systemctl restart stirlingpdf.service
To ensure that unoserver is running alongside Stirling PDF, you need to start it with the following command:
unoserver --port 2003 --interface 0.0.0.0You can add this command to your startup script or systemd service file to ensure it starts automatically with Stirling PDF.
If the install path is different, it can be customized in settings.yml:
system:
customPaths:
pipeline:
watchedFoldersDir: "" #Defaults to /pipeline/watchedFolders
finishedFoldersDir: "" #Defaults to /pipeline/finishedFolders
operations:
weasyprint: "" #Defaults to /opt/venv/bin/weasyprint
unoconvert: "" #Defaults to /opt/venv/bin/unoconvert