Skip to content

Commit

Permalink
PYTHON-3474 Improve documentation about credential handling (#1080)
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 authored Oct 18, 2022
1 parent 942e281 commit 5dec361
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
7 changes: 5 additions & 2 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
Changelog
=========

Changes in Version 4.3
----------------------
Changes in Version 4.3 (4.3.2)
------------------------------

Note: We withheld uploading tags 4.3.0 and 4.3.1 to PyPI due to a
version handling error and a necessary documentation update.

`dnspython <https://pypi.python.org/pypi/dnspython>`_ is now a required
dependency. This change makes PyMongo easier to install for use with "mongodb+srv://"
Expand Down
9 changes: 5 additions & 4 deletions doc/examples/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,11 +268,12 @@ or the local EC2 or ECS endpoint. The order in which the client searches for
when using ``pymongo_auth_aws>=1.1.0``.

Because we are now using ``boto3`` to handle credentials, the order and
locations of credentials are slightly different from previous versions.
Particularly, if you have a shared AWS credentials or config file,
locations of credentials are slightly different from before. Particularly,
if you have a shared AWS credentials or config file,
then those credentials will be used by default if AWS auth environment
variables are not set. To override this behavior, set ``AWS_PROFILE=""`` in
your shell or add ``os.environ["AWS_PROFILE"] = ""`` to your script or
variables are not set. To override this behavior, set
``AWS_SHARED_CREDENTIALS_FILE=""`` in your shell or add
``os.environ["AWS_SHARED_CREDENTIALS_FILE"] = ""`` to your script or
application. Alternatively, you can create an AWS profile specifically for
your MongoDB credentials and set ``AWS_PROFILE`` to that profile name.

Expand Down

0 comments on commit 5dec361

Please sign in to comment.