Skip to content

Commit f8921a1

Browse files
authored
DOCSP-23892 adds warning for cluster options (#387)
* DOCSP-23892 adds warning for cluster options * Fix incorrect directive
1 parent b8fcb1e commit f8921a1

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. warning::
2+
On some systems, providing a password in a connection string with
3+
the ``--cluster0`` or ``--cluster1`` options may make the password
4+
visible to system status programs, such as ``ps``, that may be invoked
5+
by other users.
6+
7+
Consider using the :option:`--config` option to specify a
8+
configuration file containing the password instead.

source/reference/mongosync.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,17 @@ Global Options
8484
To set the ``--cluster0`` option from a configuration file,
8585
see the :setting:`cluster0` setting.
8686

87+
.. include:: /includes/warn-option-cluster-password-visibility.rst
88+
8789
.. option:: --cluster1 <uri>
8890

8991
.. include:: /includes/opts/cluster1.rst
9092

9193
To set the ``--cluster1`` option from a configuration file,
9294
see the :setting:`cluster1` setting.
9395

96+
.. include:: /includes/warn-option-cluster-password-visibility.rst
97+
9498
.. option:: --config <filename>
9599

96100
Sets the path to the configuration file.

0 commit comments

Comments
 (0)