Stirling-PDF icon indicating copy to clipboard operation
Stirling-PDF copied to clipboard

[Bug]: Documentation: Unix Installation Guide omits the step to clone the actual stirling-pdf repo

Open miiichael opened this issue 2 months ago • 3 comments

Installation Method

Local Installation

The Problem

Step 5 mentions a scripts folder that I don't have yet because you didn't ask me to clone the stirling-pdf repo :P (at least, I'm assuming that's where we're supposed to get it from...)

Version of Stirling-PDF

too early within installation to be relevant :P

Last Working Version of Stirling-PDF

No response

Page Where the Problem Occurred

No response

Docker Configuration


Relevant Log Output


Additional Information

I was able to get things running satisfactorily (I even found and successfully set SYSTEM_ROOTURIPATH).

Browsers Affected

No response

No Duplicate of the Issue

  • [x] I have verified that there are no existing issues raised related to my problem.

miiichael avatar Oct 01 '25 04:10 miiichael

Hi @miiichael! I'm Dosu and I’m helping the Stirling-PDF team.

You're correct—the Unix Installation Guide doesn't currently tell users to clone the Stirling-PDF repository, which is necessary to get the scripts folder. The guide assumes you have the repo locally, but if you only download the JAR, you won't have the required scripts. The correct process is to clone the repo (e.g., git clone https://github.com/Stirling-Tools/Stirling-PDF.git), then move both the JAR and the scripts folder to your install location. This step is missing from the documentation and should be added for clarity. You can see this approach in the automated install script, which explicitly clones the repo to obtain both the JAR and scripts.

To reply, just mention @dosu.


How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other  Chat with Dosu Join Discord Share on X

dosubot[bot] avatar Oct 01 '25 04:10 dosubot[bot]

LOL. My head just spun at this too. Is the bot response the correct command? Also seems these instructions are assuming there's a gui - not just server side.

kaboddy avatar Oct 02 '25 15:10 kaboddy

I cloned the repo and just copied the scripts directory. Though I'm not sure I even needed to do that, as I didn't need to invoke any of the scripts...

I skipped the XDG desktop entry step. I also apt-get installed jbig2 rather than built it from source (which meant I uninstalled a bunch of build-dependencies without even using them).

miiichael avatar Oct 03 '25 00:10 miiichael