NS8-Stirling-PDF App

[oneitonitram (Martin)]

I HAve been working ON Alot of PDF documents recently, And part of it was What inspired the Paperlesss NGX Module here: NS8-Paperless NGX Module - Feature - NethServer Community

Paperless IS nice and a Wonderful PDF consumption tool, but it has its limitations. Part of the works was Also collaboration, And my team And I had to use PDF tools, It became clear that we needed a Better tool for PDF tool. than the Desktop PDF instalaltions w had. Enter Stirling-PDF

Stirling-PDF

Stirling PDF is Your locally hosted one-stop-shop for all your PDF needs.

It is a robust, locally hosted, web-based PDF manipulation platform powered by Docker
This One tool HAs it all in terms of PDF Document Manipulation

And to Sweeten the Deal for Developers in the Hosue, it also features an API

The Module
Now that you know what it is and what it can do, i am happy to Announce that you can install it on your Nethserver 8 as a Module. the Github Repo is here

Installing the Module

• SSH into your server

• change to root user if not already. by running: su root

• install the module by running the following command below:

add-module ghcr.io/compgeniuses/stirlingpdf:1.0.0-beta1

Updating the Module

api-cli run update-module --data '{"module_url":"ghcr.io/compgeniuses/stirlingpdf:latest","instances":["stirlingpdf"],"force":true}'

The Above Command Will pull and install the Module on your Nethserver instance

After Installation
you should find it in your installed software repos, Available on the hamburger button on the top right of you Nethserver instance

Open it, to Launch the configuration

input your configurations, and Hit save, to STart the Module.

the hostname is required for the module to start, enter your desired hotname.

if all goes well, you should Have running Services as Shown Above
Access your Instance through the given hostname URL

PS, there is a communication with the paperless team on a possible collaboration for integration, WHo knows…

i am happy for responses from your test cases, thank you

[LayLow (HF)]

@oneitonitram

Now that you know what it is and what it can do, i am happy to Announce that you can install it on your Nethserver 8 as a Module

Congrats on another module! Nice work.

Could you elaborate (non techie) on the step by step (non techie) installation procedure please?

TIA

[oneitonitram (Martin)]

HEllo @LayLow I have modified the instalaltion instructions Above here: NS8-Stirling-PDF Module

@oneitonitram

Installing the Module

• SSH into your server
• change to root user if not already. by running: su root
• install the module by running the following command below:

add-module ghcr.io/compgeniuses/stirlingpdf:1.0.0-beta1

The Above Command Will pull and install the Module on your Nethserver instance

I hope the install instructions are non techie enough

[LayLow (HF)]

@oneitonitram

install instructions

Ok, thanks. That is different than the installation via Software Center, or can the repo be added? And how about updates?

TIA

[oneitonitram (Martin)]

I HAve added the Update instruction as well, btu you can run this command if you need to update to a latest version of the moudule

api-cli run update-module --data '{"module_url":"ghcr.io/compgeniuses/stirlingpdf:latest","instances":["stirlingpdf1"],"force":true}'

you can change the latest tag with the version that would have been release, or maintain latest ot always pull the latest and greatest

With regards to Installation from the software Center, this will be possible once the module has been submitted and approved on the Nethforge repo

Your tests and feedback will enable me to work on issues that arise on the module before it can be published

[LayLow (HF)]

@oneitonitram

Your tests and feedback

What can I say, it does exactly what it says on the tin. Congrats!

• During the install command, the screen is silent and with no progress indication
• Stirling settings are saved in the bowser, but no cookie consent (EU)
• How to slightly modify GUI to remove some elements like gothic logo etc etc
• Advanced section in settings is empty
• Author in about section is not filled out correctly yet
• App log shows no issues during installation

HTH

[oneitonitram (Martin)]

@LayLow

How to slightly modify GUI to remove some elements like gothic logo etc etc

it is actually possible to implement a custom Logo with the module, as well as the name i thing

Stirling PDF allows easy customization of the app. Includes things like

• Custom application name
• Custom slogans, icons, images, and even custom HTML (via file overrides)

for the Names, I need to Pass these Parameter:

#ui:
#  appName: exampleAppName # Application's visible name
#  homeDescription: I am a description # Short description or tagline shown on homepage.
#  appNameNavbar: navbarName # Name displayed on the navigation bar

-e UI_APP_NAME=Stirling PDF \
-e UI_HOME_DESCRIPTION=Your locally hosted one-stop-shop for all your PDF needs. \
-e UI_APP_NAVBAR_NAME=Stirling PDF \

For the Logo, icon and custom HTML override, Haven’t quite figured it yet.

[LayLow (HF)]

@oneitonitram

for the Names

Found this file with those parameters hashed out…

/home/stirlingpdf1/.local/share/containers/storage/volumes/stirling-pdf-config/_data/settings.yml

Maybe make them configurable?

[LayLow (HF)]

@oneitonitram

Logo, icon and custom HTML

Luxury wishes

[oneitonitram (Martin)]

@LayLow

Luxury wishes

Unless we build Our Own Custom Docker File, and Implement Those features to be Injected During Build not sure how that would work really, But the much we can do is the names.

I have submitted a PR into the Nethforge repo: Added Stiling-PDF by compgeniuses · Pull Request #7 · NethServer/ns8-nethforge (github.com)

To make it easier to install and Update, though the Update from Nethforge are usually delayed i think for good measure.

[dnutan (Marc)]

v1.0.3 / latest

The settings.enable_security toggle switch is to enable user login? (maybe not implemented)
How to add OCR languages?

[oneitonitram (Martin)]

Yes it enables user. And you need to use or set default user as seen in Readme docs

[dnutan (Marc)]

the toggle switch always turns to off. Manually setting enable login to true via the settings.yml file and restarting the services doesn’t redirect to /login or give any login form.
About the prerequisites I don’t know how to do it on my own or if they are already applied at build time.
Just testing…

Prerequisites:

• User must have the folder ./configs volumed within docker so that it is retained during updates.
• Docker uses must download the security jar version by setting >DOCKER_ENABLE_SECURITY to true in environment variables.
• Then either enable login via the settings.yml file or via setting SECURITY_ENABLE_LOGIN to true
• Now the initial user will be generated with username admin and password stirling. On login you will be forced to change the password to a new one. You can also use the environment variables SECURITY_INITIALLOGIN_USERNAME and SECURITY_INITIALLOGIN_PASSWORD to set your own straight away (Recommended to remove them after user creation).

Once the above has been done, on restart, a new stirling-pdf-DB.mv.db will show if everything worked.

When you login to Stirling PDF you will be redirected to /login page to login with those default credentials. After login everything should function as normal

To access your account settings go to Account settings in the settings cog menu (top right in navbar) This Account settings menu is also where you find your API key.

To add new users go to the bottom of Account settings and hit ‘Admin Settings’, here you can add new users.