Fix: Stirling-PDF > LibreOffice/unoconv Integration Issues

[m6urns]

✍️ Description

The current installation script for the StirlingPDF LXC has issues with LibreOffice and unoconv integration, causing document conversion failures. These issues are caused by the following:

1. Missing LibreOffice dependencies
2. No dedicated LibreOffice listener service
3. Incorrect port configuration for unoconv/LibreOffice communication
4. Missing environment variables for Python-UNO bridge

Issues with document conversion and missing environmental variables were resolved by:

1. Adding essential LibreOffice packages (libreoffice-core, libreoffice-common, libreoffice-base-core)
2. Explicitly installing python3-uno
3. Creating a dedicated LibreOffice listener service configured for port 2002 (unoconv's default)
4. Adding necessary environment variables for proper Python-UNO bridge functionality
5. Modifying StirlingPDF service to depend on LibreOffice listener service
6. Adding service configuration for automatic restarts

---

• Related Issue: Stirling-PDF LXC - LibreOffice/unoconv Integration Fails in Fresh Installations #1321

---

🛠️ Type of Change

Please check the relevant options:

• Bug fix (non-breaking change that resolves an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change unexpectedly)
• New script (a fully functional and thoroughly tested script or set of scripts)

---

✅ Prerequisites

The following steps must be completed for the pull request to be considered:

• Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.)
• Testing performed (I have thoroughly tested my changes and verified expected functionality.)
• Documentation updated (I have updated any relevant documentation)

---

📋 Additional Information (optional)

Provide any extra context or screenshots about the feature or fix here.

[MickLesk]

Please add/write an short guide here for users that have already an existing LXC (Breaking Change) to update the own LXC

[github-actions]

Script validation

❌ We found issues in the following changed files:

Not executable:

• .github/workflows/validate-filenames.yml
• .github/workflows/validate-formatting.yaml
• .github/workflows/validate-scripts.yml
• CHANGELOG.md
• install/stirling-pdf-install.sh
• json/postgresql.json

Copyright header line missing or invalid:

• .github/workflows/validate-filenames.yml
• .github/workflows/validate-formatting.yaml
• .github/workflows/validate-scripts.yml
• CHANGELOG.md
• json/postgresql.json

Author header line missing or invalid:

• .github/workflows/validate-filenames.yml
• .github/workflows/validate-formatting.yaml
• .github/workflows/validate-scripts.yml
• CHANGELOG.md
• json/postgresql.json

License header line missing or invalid:

• .github/workflows/validate-filenames.yml
• .github/workflows/validate-formatting.yaml
• .github/workflows/validate-scripts.yml
• CHANGELOG.md
• install/stirling-pdf-install.sh
• json/postgresql.json

Source header line missing or invalid:

• .github/workflows/validate-filenames.yml
• .github/workflows/validate-formatting.yaml
• .github/workflows/validate-scripts.yml
• CHANGELOG.md
• install/stirling-pdf-install.sh
• json/postgresql.json

[m6urns]

Repairing an existing installation of the Stirling-PDF LXC

1. Ensure essential LibreOffice components are installed

apt-get install -y \
  libreoffice-core \
  libreoffice-common \
  libreoffice-base-core \
  python3-uno

2. Create a LibreOffice listener service

cat <<EOF >/etc/systemd/system/libreoffice-listener.service
[Unit]
Description=LibreOffice Headless Listener Service
After=network.target

[Service]
Type=simple
User=root
Group=root
ExecStart=/usr/lib/libreoffice/program/soffice --headless --invisible --nodefault --nofirststartwizard --nolockcheck --nologo --accept="socket,host=127.0.0.1,port=2002;urp;StarOffice.ComponentContext"
Restart=always

[Install]
WantedBy=multi-user.target
EOF

3. Configure Environmental Variables

cat <<EOF >/opt/Stirling-PDF/.env
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/lib/libreoffice/program
UNO_PATH=/usr/lib/libreoffice/program
PYTHONPATH=/usr/lib/python3/dist-packages:/usr/lib/libreoffice/program
LD_LIBRARY_PATH=/usr/lib/libreoffice/program
EOF

4. Update Stirling-PDF Service

cat <<EOF >/etc/systemd/system/stirlingpdf.service
[Unit]
Description=Stirling-PDF service
After=syslog.target network.target libreoffice-listener.service
Requires=libreoffice-listener.service

[Service]
SuccessExitStatus=143
Type=simple
User=root
Group=root
EnvironmentFile=/opt/Stirling-PDF/.env
WorkingDirectory=/opt/Stirling-PDF
ExecStart=/usr/bin/java -jar Stirling-PDF.jar
ExecStop=/bin/kill -15 %n
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target
EOF

5. Enable and Restart Services

systemctl daemon-reload
systemctl enable -q --now libreoffice-listener
systemctl restart stirlingpdf