Add info on self-signed https connections from the API #288
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for actualbudget-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
youngcw
approved these changes
Dec 8, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to actualbudget/actual#1695
It's pretty common for users to have self-signed certificates for actual, but this presents some challenges for the API.
Give a little bit of guidance here, for new contributors. Really, all the info here is just for Node.js and not for actual. (we would want to create seperate http agents and our own certificate config system if we wanted to have actual specific config for this).
For many of the existing api use-cases the
NODE_TLS_REJECT_UNAUTHORIZEDoption will be fine. ButNODE_EXTRA_CA_CERTSseems like the proper way to do things (and the one I tested on nodejs 21, on ubuntu via asdf install). But I also made sure to mention the option of using openssl's ca certificates, because if you are in a situation where your node.js is configured to link to the system openssl on Linux, it's going to be the easiest and most familiar to Linux sysadmins. It's just not the cross-platform supported option likeNODE_EXTRA_CA_CERTS.