rethinkdb / rethinkdb/docs

r.connect({ssl: {}}) has undocumented options

Open
#1,183 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

The docs for the JS driver's r.connect says for the ssl key:

Currently, there is only one option available

But this is incorrect. The driver passes the entire SSL object to tls.connect here, so it can use all of tls.connect's options.

In particular, I needed to make use of rejectUnauthorized: false as a temp fix because my server was rejecting Compose's self-signed ssl certificate with a "unable to verify the first certificate" error.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the r.connect documentation section describing the ssl key, then read drivers/javascript/net.coffee around line 959 and the linked Node.js tls.connect options. Done means the documentation accurately explains that SSL options are passed through and points readers to the supported tls.connect options, including rejectUnauthorized.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.