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

docs - update TLS/SSL guide for Mongoose v8 - MongoDB v6 driver deprecations #14170

Merged
merged 5 commits into from Dec 21, 2023

Conversation

andylwelch
Copy link
Contributor

Summary

The current SSL documentation is invalid for Mongoose v8 as the MongoDB Node.js driver v6.0.0 removed the deprecated SSL option.

Fixes #14166

Examples

The documentation has been updated to use the new equivalents:

  • sslValidate: false -> tlsAllowInvalidCertificates: true & tlsAllowInvalidHostnames: true
  • sslCA -> tlsCAFile
  • sslCRL -> tlsCRLFile
  • sslCert -> tlsCertificateKeyFile
  • sslKey -> tlsCertificateKeyFile
  • sslPass -> tlsCertificateKeyFilePassword
  • sslValidate -> tlsAllowInvalidCertificates
  • tlsCertificateFile -> tlsCertificateKeyFile

Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

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

A couple of minor comments, mostly questions that I want to clarify. If you are able to answer them that would be helpful, I'll do my own research as well.

docs/tutorials/ssl.md Outdated Show resolved Hide resolved
docs/tutorials/ssl.md Outdated Show resolved Hide resolved
- use `tls: true` for likelihood of ssl: true being removed
- confirm tls is enabled by mongodb+srv://
https://www.mongodb.com/docs/manual/reference/connection-string/
@andylwelch
Copy link
Contributor Author

Please let me know if you have any more questions, or if you have any more feedback.

@vkarpov15 vkarpov15 added this to the 8.0.4 milestone Dec 21, 2023
Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@vkarpov15 vkarpov15 merged commit 6d87344 into Automattic:master Dec 21, 2023
1 of 2 checks 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.

missing properties in mongoose.ConnectOptions types for ssl
2 participants