Skip to content

Paperless-ngx add ability to set custom PostgreSQL connection #192

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

Conversation

AlexandrAkavity
Copy link

🛑 New scripts must first be submitted to ProxmoxVED for testing.
PRs for new scripts that skip this process will be closed.


✍️ Description

Paperless-ngx already exists, just added small functionality to it
Add ability to select custom PostgreSQL connection directly while setting up the paperless-ngx

✅ Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected.
  • No breaking changes – Existing functionality remains intact.
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.

🛠️ Type of Change (X in brackets)

  • 🐞 Bug fix – Resolves an issue without breaking functionality.
  • New feature – Adds new, non-breaking functionality.
  • 💥 Breaking change – Alters existing functionality in a way that may require updates.
  • 🆕 New script – A fully functional and tested script or script set.
  • 🌍 Website update – Changes to website-related JSON files or metadata.
  • 🔧 Refactoring / Code Cleanup – Improves readability or maintainability without changing functionality.
  • 📝 Documentation update – Changes to README, AppName.md, CONTRIBUTING.md, or other docs.

🔍 Code & Security Review (X in brackets)

  • Follows Code_Audit.md & CONTRIBUTING.md guidelines
  • Uses correct script structure (AppName.sh, AppName-install.sh, AppName.json)
  • No hardcoded credentials

@michelroegl-brunner
Copy link
Member

Tbh, this adds so much unneeded complexity to the script. We try to do them with as little User input as possible, and we can not maintain this. There will be issues with people not knowing what they are doing, and break the script.

I advise against it.

@AlexandrAkavity
Copy link
Author

Tbh, this adds so much unneeded complexity to the script. We try to do them with as little User input as possible, and we can not maintain this. There will be issues with people not knowing what they are doing, and break the script.

I advise against it.

It isn't a complexity but a required option.
When I tried to change the DB config for paperless after regular installation, it did not work. Somehow, paperless continue to use local one.
As an alternative solution, I can change the message to:
"Would you like to use a custom PostgreSQL server instead of local one? <y/N>"

@MickLesk
Copy link
Member

And for what ? It doesnt do anything performance boost or something.

@tremor021
Copy link
Member

Giving users option to use custom server sound good on paper, but opens up bunch of other problems. Like, bad user input resulting in numerous issues reported as a script issue.

Also, performance wise, you're not really gaining any. Its just a database on a different location rather on one central place.
I will support this only if other @community-scripts/contributor do

@MickLesk MickLesk closed this May 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants