hyperledger-firefly / hyperledger-firefly/helm-charts
Document Postgres URL Requirements
- Dominant language
- Go Template
- Stars
- 17
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
We've seen in some cases folks have Postgres password with special characters in them that require URL encoding.
Since we take in the URL in both FF config and the migrations job, its not appropriate for the script to parse the URL and then (re-)encode the password since it could potentially already be encoded properly.
Instead, we just need to make sure this is well documented.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the documentation for Postgres URLs used by the FF configuration and migrations job. Document that passwords containing special characters must be URL-encoded, while already encoded values should be passed through unchanged; done when both usage paths state this requirement clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm, postgresql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100