Skip to content

Commit b04b674

Browse files
author
Sam Kleinman
committed
DOCS-79 pulication edits
1 parent d4c0607 commit b04b674

File tree

4 files changed

+30
-26
lines changed

4 files changed

+30
-26
lines changed

source/administration/security.txt

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ follow a system of least privilege, and follow best development and
2121
deployment practices. See the :ref:`security-reduce-risk` section for
2222
more information.
2323

24+
.. _security-reduce-risk:
25+
2426
Strategies for Reducing Risk
2527
----------------------------
2628

@@ -66,11 +68,13 @@ Vulnerability Notification
6668
seriously. If you discover a vulnerability in MongoDB or another
6769
10gen product, or would like to know more about our vulnerability
6870
reporting and response process, see the
69-
:doc:`/vulnerability-notification` document.
71+
:doc:`/administration/vulnerability-notification` document.
7072

7173
Networking Risk Exposure
7274
------------------------
7375

76+
.. _security-port-numbers:
77+
7478
Interfaces and Port Numbers
7579
~~~~~~~~~~~~~~~~~~~~~~~~~~~
7680

@@ -245,10 +249,11 @@ Authentication
245249

246250
MongoDB provides basic support for authentication with the
247251
:setting:`auth` setting. For multi-instance deployments
248-
(i.e. :term:`replica sets`, and :term:`sharded clusters`) use the
249-
:setting:`keyFile` setting, which implies :setting:`auth`, and allows
250-
intra-deployment authentication and operation. Be aware of the
251-
following behaviors of MongoDB's authentication system:
252+
(i.e. :term:`replica sets <replica set>`, and :term:`sharded clusters
253+
<sharded cluster>`) use the :setting:`keyFile` setting, which implies
254+
:setting:`auth`, and allows intra-deployment authentication and
255+
operation. Be aware of the following behaviors of MongoDB's
256+
authentication system:
252257

253258
- Authentication is **disabled** by default.
254259

@@ -301,7 +306,7 @@ following behaviors of MongoDB's authentication system:
301306
trusted networking configuration.
302307

303308
Consider the
304-
:doc:`/tutorial/use-authentication-to-control-access-to-mongodb`
309+
:doc:`/tutorial/control-access-to-mongodb-with-authentication`
305310
document which outlines procedures for configuring and maintaining
306311
users and access with MongoDB's authentication system.
307312

source/tutorial/configure-linux-iptables-firewall.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Traffic to and from ``mongos`` Instances
9999
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100100

101101
:program:`mongos` instances provide query routing for :term:`sharded
102-
clusters`. Clients connect to :program:`mongos` instances, which
102+
clusters <sharded cluster>`. Clients connect to :program:`mongos` instances, which
103103
behave from the client's perspective as :program:`mongod`
104104
instances. In turn, the :program:`mongos` connects to all
105105
:program:`mongod` instances that are components of the sharded

source/tutorial/configure-windows-netsh-firewall.txt

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ as standalone instances or as part of a :term:`replica set`.
7272
The goal of this pattern is to explicitly allow traffic to the
7373
:program:`mongod.exe` instance from the application server.
7474

75-
.. code-block:: netsh
75+
.. code-block:: bat
7676

7777
netsh advfirewall firewall add rule name="Open mongod port 27017" dir=in action=allow protocol=TCP localport=27017
7878

@@ -84,22 +84,22 @@ allows the application server to connect to the
8484
an entire application rather than to a specific port, as in the
8585
following example:
8686

87-
.. code-block:: netsh
87+
.. code-block:: bat
8888

8989
netsh advfirewall firewall add rule name="Allowing mongod" dir=in action=allow program=" C:\mongodb\bin\mongod.exe"
9090

9191
You can allow all access for a :program:`mongos.exe` server, with the
9292
following invocation:
9393

94-
.. code-block:: netsh
94+
.. code-block:: bat
9595

9696
netsh advfirewall firewall add rule name="Allowing mongos" dir=in action=allow program=" C:\mongodb\bin\mongos.exe"
9797

9898
Traffic to and from ``mongos.exe`` Instances
9999
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100100

101101
:program:`mongos.exe` instances provide query routing for
102-
:term:`sharded clusters`. Clients connect to :program:`mongos.exe`
102+
:term:`sharded clusters <sharded cluster>`. Clients connect to :program:`mongos.exe`
103103
instances, which behave from the client's perspective as
104104
:program:`mongod.exe` instances. In turn, the :program:`mongos.exe`
105105
connects to all :program:`mongod.exe` instances that are components of
@@ -109,7 +109,7 @@ Use the same :guilabel:`Windows Firewall` command to allow traffic to
109109
and from these instances as you would from the :program:`mongod.exe`
110110
instances that are members of the replica set.
111111

112-
.. code-block:: netsh
112+
.. code-block:: bat
113113

114114
netsh advfirewall firewall add rule name="Open mongod shard port 27018" dir=in action=allow protocol=TCP localport=27018
115115

@@ -124,7 +124,7 @@ option. [#config-option]_ Configuration servers listen for connections on port
124124
config server to allow incoming and outgoing connection on port
125125
``27019``, for connection to the other config servers.
126126

127-
.. code-block:: netsh
127+
.. code-block:: bat
128128

129129
netsh advfirewall firewall add rule name="Open mongod config svr port 27019" dir=in action=allow protocol=TCP localport=27019
130130

@@ -133,7 +133,7 @@ all of the :program:`mongos.exe` instances in the cluster *and* all
133133
:program:`mongod.exe` instances in the cluster. Add rules that
134134
resemble the following:
135135

136-
.. code-block:: netsh
136+
.. code-block:: bat
137137

138138
netsh advfirewall firewall add rule name="Open mongod config svr inbound" dir=in action=allow protocol=TCP remoteip=<ip-address> localport=27019
139139

@@ -152,7 +152,7 @@ For shard servers, running as :option:`mongod --shardsvr`
152152
:setting:`shardsvr` is ``27018``, you must configure the following
153153
:guilabel:`Windows Firewall` rules to allow traffic to and from each shard:
154154

155-
.. code-block:: netsh
155+
.. code-block:: bat
156156

157157
netsh advfirewall firewall add rule name="Open mongod shardsvr inbound" dir=in action=allow protocol=TCP remoteip=<ip-address> localport=27018
158158
netsh advfirewall firewall add rule name="Open mongod shardsvr outbound" dir=out action=allow protocol=TCP remoteip=<ip-address> localport=27018
@@ -176,7 +176,7 @@ Create a rule that resembles the following, and replace the
176176
``<ip-address>`` with the address of the config servers and the
177177
:program:`mongos.exe` instances:
178178

179-
.. code-block:: netsh
179+
.. code-block:: bat
180180

181181
netsh advfirewall firewall add rule name="Open mongod config svr outbound" dir=out action=allow protocol=TCP remoteip=<ip-address> localport=27018
182182

@@ -200,7 +200,7 @@ Provide Access For Monitoring Systems
200200
#. If your monitoring system needs access the HTTP interface, insert
201201
the following rule to the chain:
202202

203-
.. code-block:: netsh
203+
.. code-block:: bat
204204

205205
netsh advfirewall firewall add rule name="Open mongod HTTP monitoring inbound" dir=in action=allow protocol=TCP remoteip=<ip-address> localport=28017
206206

@@ -214,14 +214,14 @@ Provide Access For Monitoring Systems
214214
For shard server :program:`mongod.exe` instances running with
215215
:setting:`shardsvr`, the rule would resemble the following:
216216

217-
.. code-block:: netsh
217+
.. code-block:: bat
218218

219219
netsh advfirewall firewall add rule name="Open mongos HTTP monitoring inbound" dir=in action=allow protocol=TCP remoteip=<ip-address> localport=28018
220220

221221
For config server :program:`mongod.exe` instances running with
222222
:setting:`configsvr`, the rule would resemble the following:
223223

224-
.. code-block:: netsh
224+
.. code-block:: bat
225225

226226
netsh advfirewall firewall add rule name="Open mongod configsvr HTTP monitoring inbound" dir=in action=allow protocol=TCP remoteip=<ip-address> localport=28019
227227

@@ -238,7 +238,7 @@ Delete all *Windows Firewall* Rules
238238

239239
To delete the firewall rule allowing :program:`mongod.exe` traffic:
240240

241-
.. code-block:: netsh
241+
.. code-block:: bat
242242

243243
netsh advfirewall firewall delete rule name="Open mongod port 27017" protocol=tcp localport=27017
244244

@@ -249,7 +249,7 @@ List All *Windows Firewall* Rules
249249

250250
To return a list of all :guilabel:`Windows Firewall` rules:
251251

252-
.. code-block:: netsh
252+
.. code-block:: bat
253253

254254
netsh advfirewall firewall show rule name=all
255255

@@ -258,7 +258,7 @@ Reset *Windows Firewall*
258258

259259
To reset the :guilabel:`Windows Firewall` rules:
260260

261-
.. code-block:: netsh
261+
.. code-block:: bat
262262

263263
netsh advfirewall reset
264264

@@ -270,14 +270,14 @@ import firewall systems from different servers) rules very easily on Windows:
270270

271271
Export all firewall rules with the following command:
272272

273-
.. code-block:: netsh
273+
.. code-block:: bat
274274

275275
netsh advfirewall export "C:\temp\MongoDBfw.wfw"
276276

277277
Replace ``"C:\temp\MongoDBfw.wfw"`` with a path of your choosing. You
278278
can use a command in the following form to import a file created using
279279
this operation:
280280

281-
.. code-block:: netsh
281+
.. code-block:: bat
282282

283283
netsh advfirewall import "C:\temp\MongoDBfw.wfw"

source/tutorial/control-access-to-mongodb-with-authentication.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ Control Access to MongoDB Instances with Authentication
77
MongoDB provides a basic authentication system, that you can enable
88
with the :setting:`auth` and :setting:`keyFile` configuration
99
settings. [#cli-options]_ See the :ref:`authentication
10-
<security-authentication>` section of the :doc:`/authentication/security`
11-
document.
10+
<security-authentication>` section of the :doc:`/administration/security` document.
1211

1312
This document contains an overview of all operations related to
1413
authentication and managing a MongoDB deployment with authentication.

0 commit comments

Comments
 (0)