-
Notifications
You must be signed in to change notification settings - Fork 1.5k
DOCSP-35939: tls #2894
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
DOCSP-35939: tls #2894
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great -- I think a few straightforward tweaks could improve the focus of the content. I don't think I need to review again, but happy to take another look if you want.
docs/fundamentals/connection/tls.txt
Outdated
You can alternatively reference your certificates by setting options | ||
in the ``driverOptions`` property in your connection configuration. | ||
To learn more about these options, see the | ||
`MongoDB\Driver\Manager::__construct() | ||
<https://www.php.net/manual/en/mongodb-driver-manager.construct.php>`__ | ||
API documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion:
In the referenced link, it's not clear to me which settings are safe to use. The driverOptions settings, such as such as ca_file, pem_file, and pem_pwd, on the page are described as "deprecated alias for the [option name] URI option" .
I think it could be helpful to mention which settings to recommend since it's not clear on the linked page. Maybe @GromNaN can provide more guidance here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd ask @jmikola. I don't know this option. I learned about this feature by reading your doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The URI options prefixed with tls
supersede the driverOptions
. There are very few options that are only supported through driverOptions
(e.g. crl_file
), and I don't think any of those are relevant to these docs.
I think the right call is to remove any discussion of driverOptions
. You can still link to the Manager constructor as canonical documentation for URI options, though. In that case, you can drop a link to it in the "Additional Information" section below (probably above the server docs, since it will be more relevant to PHP).
driverOptions
property
Is this actually a property in the Laravel configuration? If you're referring to the Manager constructor, then the proper terminology would be "driverOptions
parameter" (not "property").
But this may be a moot point since the entire note can be removed.
docs/fundamentals/connection/tls.txt
Outdated
You can alternatively reference your certificates by setting options | ||
in the ``driverOptions`` property in your connection configuration. | ||
To learn more about these options, see the | ||
`MongoDB\Driver\Manager::__construct() | ||
<https://www.php.net/manual/en/mongodb-driver-manager.construct.php>`__ | ||
API documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The URI options prefixed with tls
supersede the driverOptions
. There are very few options that are only supported through driverOptions
(e.g. crl_file
), and I don't think any of those are relevant to these docs.
I think the right call is to remove any discussion of driverOptions
. You can still link to the Manager constructor as canonical documentation for URI options, though. In that case, you can drop a link to it in the "Additional Information" section below (probably above the server docs, since it will be more relevant to PHP).
driverOptions
property
Is this actually a property in the Laravel configuration? If you're referring to the Manager constructor, then the proper terminology would be "driverOptions
parameter" (not "property").
But this may be a moot point since the entire note can be removed.
I leave it to @jmikola to approve. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I'll leave you to address the tlsInsecure
documentation on your own and don't need to review that a second time.
docs/fundamentals/connection/tls.txt
Outdated
|
||
- ``tlsAllowInvalidCertificates`` | ||
- ``tlsAllowInvalidHostnames`` | ||
- ``tlsInsecure`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quoting https://www.php.net/manual/en/mongodb-driver-manager.construct.php:
Specifying true for this option has the same effect as specifying true for both the "tlsAllowInvalidCertificates" and "tlsAllowInvalidHostnames" URI options. Defaults to false.
There should be no reason for the user to specify all three options. The improvement here would be to note that tlsInsecure
implies the other two options.
Sorry for missing this earlier. This change should probably be applied to whatever content this was copied/adapted from (assuming other driver docs would be affected).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
https://jira.mongodb.org/browse/DOCSP-35939
STAGING
Docs PR - https://github.com/10gen/docs-laravel/pull/69
Checklist