Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install locally on a machine with no-root, docker, apt, yum, and apk via nix package manager. #1188

Merged
merged 4 commits into from
May 9, 2024

Conversation

bluestero
Copy link
Contributor

Description

So, I worked on a template to contribute to Codesphere which involved installing Stirling-PDF and its dependencies locally.
The catch was that there was no root access and packages should be installed via Nix package manager (nix-env).
So it took me many many hours to research and find a way to make it work using no-root and Nix.
So this PR contains my edit in the LocalRunGuide.md file where I added instructions for the no-root and Nix method.

Also, I caught a small line break issue and fixed it along the way:
Line break image

Closes #1175

Checklist:

✅ I have read the Contribution Guidelines.
✅ I have performed a self-review of my own code.
✅ I have commented my code, particularly in hard-to-understand areas.
✅ My changes generate no new warnings.

Contributor License Agreement

By submitting this pull request, I acknowledge and agree that my contributions will be included in Stirling-PDF and that they can be relicensed in the future under the MPL 2.0 (Mozilla Public License Version 2.0) license.

(This does not change the general open-source nature of Stirling-PDF, simply moving from one license to another license)

@bluestero bluestero requested a review from Frooodle as a code owner May 7, 2024 19:58

```bash
mkdir temp
export DBUS_SESSION_BUS_ADDRESS="unix:path=./temp"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add comment explaining what this does

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes will do so.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Frooodle Done

### Step 6: Other files
#### OCR
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.

##### Installing Language Packs
Easiest is to use the langpacks provided by your repositories. Skip the other steps
Easiest is to use the langpacks provided by your repositories. Skip the other steps.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dont understand the wording here

Do you mean using a package manager is better than manual?
Shall we change the order to move manual to bottom and package managers to top and remove this text?

Not sure what you mean by Note: Nix Package Manager pre-installs almost all the packages by default.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah my bad, I meant pre-installs all the 'language' packages by default. Will fix this one up.

@Frooodle Frooodle merged commit 692a526 into Stirling-Tools:main May 9, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Install and deploy on a Linux machine without docker, root (superuser), apt, yum, or apk (via nix-env).
2 participants