Skip to content

Commit 15cad66

Browse files
author
Anthony Sansone
committed
(DOCSP-10468): Update Windows install.
1 parent 7e08223 commit 15cad66

14 files changed

+599
-362
lines changed

‎source/includes/extracts-install-past-mongodb.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ content: |
33
.. note::
44
55
To install a different version of MongoDB, please refer to that
6-
version's documentation. For example, see version {{installLink}}.
6+
version's documentation. To install the previous version, see
7+
the tutorial for version {{installLink}}.
78
---
89

910
# Community

‎source/includes/fact-default-bind-ip-change.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
Starting in MongoDB 3.6, MongoDB binaries, :binary:`~bin.mongod` and
2-
:binary:`~bin.mongos`, bind to localhost by default.
3-
Previously, starting in MongoDB 2.6, only the binaries from the
1+
Starting with MongoDB 3.6, MongoDB binaries, :binary:`~bin.mongod` and
2+
:binary:`~bin.mongos`, bind to ``localhost`` by default.
3+
From MongoDB versions 2.6 to 3.4, only the binaries from the
44
official MongoDB RPM (Red Hat, CentOS, Fedora Linux, and derivatives)
5-
and DEB (Debian, Ubuntu, and derivatives) packages bind to localhost by
6-
default. For more details, see :ref:`3.6-bind_ip-compatibility`.
5+
and DEB (Debian, Ubuntu, and derivatives) packages would bind to
6+
``localhost`` by default. To learn more about this change, see
7+
:ref:`3.6-bind_ip-compatibility`.

‎source/includes/fact-install-windows-prereq.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
Hardware Requirements
2+
~~~~~~~~~~~~~~~~~~~~~
3+
4+
|mdb-edition| requires an x86 64-bit architecture.
5+
6+
Software Requirements
7+
~~~~~~~~~~~~~~~~~~~~~
8+
9+
Install on Windows 7 / Server 2008 R2 or Later
10+
|mdb-edition| requires Microsoft Windows Server
11+
2008 R2 or later or Microsoft Windows 7 or later for the x86 64-bit
12+
architecture.
13+
14+
To find which version, service pack, and build of Windows is
15+
running on your host, as well as the processor type of that host,
16+
enter the following command in either the :guilabel:`Command Prompt`
17+
or :guilabel:`Powershell`:
18+
19+
.. code-block:: powershell
20+
21+
PS C:\> systeminfo | findstr /B /C:"OS Name" /C:"OS Version" /C:"System Type"
22+
23+
.. code-block:: powershell
24+
:copyable: false
25+
26+
OS Name: Microsoft Windows 10 Pro
27+
OS Version: 10.0.17134 N/A Build 17134
28+
System Type: x64-based PC
29+
30+
Show All File Name Extensions
31+
Make certain that you set Windows Explorer to show file name
32+
extensions for all file types. This can prevent issues where the
33+
file type displayed to the user differs from the actual file type.
34+
35+
.. example::
36+
37+
If Windows Explorer has known file extensions hidden, what may
38+
appear to be ``mongod.cfg`` is actually ``mongod.cfg.txt``.
39+
40+
Install all Windows Updates
41+
Before installing MongoDB, update your Windows host with the latest
42+
system updates. At minimum, ensure the following Windows updates
43+
are installed on the host:
44+
45+
- Windows 2012 Server and Windows 10 need
46+
`KB2999226 <https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows>`__
47+
to provide Universal C Runtime support for Windows.
48+
49+
- Windows Server 2008 R2 and Windows 7 need
50+
`KB2731284 <http://support.microsoft.com/kb/2731284>`__ to resolve
51+
an issue with memory mapped files on Windows.
52+
53+
The Windows installer (``.msi``) file includes all other
54+
software dependencies and automatically upgrades any previous version
55+
of MongoDB that was installed using an ``.msi`` file.
56+
57+
Security
58+
~~~~~~~~
59+
60+
.. include:: /includes/fact-default-bind-ip-change.rst
61+
62+
.. warning::
63+
64+
Do not expose :binary:`~bin.mongod.exe` to a public network without
65+
configuring authentication. MongoDB is designed to be run in
66+
trusted environments.

‎source/includes/fact-install-windows.rst

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
1-
In Windows Explorer, locate the downloaded MongoDB ``.msi`` file, which
2-
typically is located in the default ``Downloads`` folder. Double-click
3-
the ``.msi`` file. The Windows Installer guides you through the
4-
installation process.
1+
1. Open Windows Explorer.
52

6-
You may specify an installation directory if you choose the
7-
:guilabel:`Custom` installation option.
3+
2. Change the directory path to where you downloaded the MongoDB
4+
``.msi`` file. By default, this is ``%HOMEPATH%\Downloads``.
85

9-
.. note::
6+
3. Double-click the ``.msi`` file.
107

11-
These instructions assume that you have installed MongoDB
12-
to ``C:\Program Files\MongoDB\Server\{+version+}\``.
8+
4. The Windows Installer guides you through the installation process.
139

14-
During the installation process you will be given the option to install
15-
:ref:`MongoDB Compass <compass-index>` in addition to MongoDB Server.
10+
If you choose the :guilabel:`Custom` installation option, you may
11+
specify an installation directory.
12+
13+
MongoDB does not have any other system dependencies. You can install and run MongoDB from any folder you choose.
14+
15+
.. note::
16+
17+
This tutorial assumes that you installed MongoDB
18+
in ``C:\Program Files\MongoDB\Server\{+version+}\``.
19+
20+
During the installation process you will be given the option to
21+
install :ref:`MongoDB Compass <compass-index>` after installing
22+
MongoDB Server. Clear the checkbox for this option. At this time,
23+
there is an installation error that occurs when installing Compass
24+
using the MongoDB Server installer.
1625

17-
MongoDB is self-contained and does not have any other system
18-
dependencies. You can run MongoDB from any folder you choose. You may
19-
install MongoDB in any folder (e.g. ``D:\test\mongodb``).

‎source/includes/release-base.yaml

Lines changed: 75 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,94 @@ code: |
1212
---
1313
ref: _install-windows
1414
copyable: true
15-
language: powershell
15+
language: bat
16+
code: |
17+
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi
18+
---
19+
ref: _install-windows-nocompass
20+
copyable: true
21+
language: bat
22+
code: |
23+
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^
24+
SHOULD_INSTALL_COMPASS="0"
25+
---
26+
ref: _install-windows-ent
27+
copyable: true
28+
language: bat
29+
code: |
30+
msiexec.exe /q /i mongodb-win32-x86_64-enterprise-windows-64-{{version}}-signed.msi
31+
---
32+
ref: _install-windows-ent-nocompass
33+
copyable: true
34+
language: bat
35+
code: |
36+
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^
37+
SHOULD_INSTALL_COMPASS="0"
38+
---
39+
ref: _install-windows-custom-location
40+
copyable: true
41+
language: bat
42+
code: |
43+
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^
44+
INSTALLLOCATION="{{location}}"
45+
---
46+
ref: _install-windows-custom-location-nocompass
47+
copyable: true
48+
language: bat
49+
code: |
50+
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^
51+
INSTALLLOCATION="{{location}}" ^
52+
SHOULD_INSTALL_COMPASS="0"
53+
---
54+
ref: _install-windows-ent-custom-location
55+
copyable: true
56+
language: bat
57+
code: |
58+
msiexec.exe /q /i mongodb-win32-x86_64-enterprise-windows-64-{{version}}-signed.msi ^
59+
INSTALLLOCATION="{{location}}"
60+
---
61+
ref: _install-windows-specify-local
62+
copyable: true
63+
language: bat
64+
code: |
65+
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^
66+
ADDLOCAL="{{addlocal}}"
67+
---
68+
ref: _install-windows-specify-local-nocompass
69+
copyable: true
70+
language: bat
71+
code: |
72+
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^
73+
ADDLOCAL="{{addlocal}}" ^
74+
SHOULD_INSTALL_COMPASS="0"
75+
---
76+
ref: _install-windows-ent-specify-local
77+
copyable: true
78+
language: bat
79+
code: |
80+
msiexec.exe /q /i mongodb-win32-x86_64-enterprise-windows-64-{{version}}-signed.msi ^
81+
ADDLOCAL="{{addlocal}}"
82+
---
83+
ref: _install-windows-custom-location-specify-local
84+
copyable: true
85+
language: bat
1686
code: |
1787
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^
1888
INSTALLLOCATION="{{location}}" ^
1989
ADDLOCAL="{{addlocal}}"
2090
---
21-
ref: _install-windows-nocompass
91+
ref: _install-windows-custom-location-specify-local-nocompass
2292
copyable: true
23-
language: powershell
93+
language: bat
2494
code: |
2595
msiexec.exe /q /i mongodb-win32-x86_64-2008plus-ssl-{{version}}-signed.msi ^
2696
INSTALLLOCATION="{{location}}" ^
2797
ADDLOCAL="{{addlocal}}" ^
2898
SHOULD_INSTALL_COMPASS="0"
2999
---
30-
ref: _install-windows-ent
100+
ref: _install-windows-ent-custom-location-specify-local
31101
copyable: true
32-
language: powershell
102+
language: bat
33103
code: |
34104
msiexec.exe /q /i mongodb-win32-x86_64-enterprise-windows-64-{{version}}-signed.msi ^
35105
INSTALLLOCATION="{{location}}" ^

‎source/includes/release-specifications.yaml

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,18 @@ replacement:
3333
ref: install-windows-addlocal
3434
source:
3535
file: release-base.yaml
36-
ref: _install-windows
36+
ref: _install-windows-specify-local
3737
replacement:
3838
location: 'C:\Program Files\MongoDB\Server\{+version+}\'
3939
addlocal: 'MonitoringTools,ImportExportTools,MiscellaneousTools'
4040
---
41+
ref: install-windows-addlocation
42+
source:
43+
file: release-base.yaml
44+
ref: _install-windows-custom-location
45+
replacement:
46+
location: 'C:\MongoDB\Server\{+version+}\'
47+
---
4148
ref: install-ent-windows-default
4249
source:
4350
file: release-base.yaml
@@ -49,8 +56,22 @@ replacement:
4956
ref: install-ent-windows-addlocal
5057
source:
5158
file: release-base.yaml
52-
ref: _install-windows-ent
59+
ref: _install-windows-ent-specify-local
5360
replacement:
5461
location: 'C:\Program Files\MongoDB\Server\{+version+}\'
5562
addlocal: 'MonitoringTools,ImportExportTools,MiscellaneousTools'
63+
---
64+
ref: install-ent-windows-addlocation
65+
source:
66+
file: release-base.yaml
67+
ref: _install-windows-ent-custom-location
68+
replacement:
69+
location: 'C:\MongoDB\Server\{+version+}\'
70+
---
71+
ref: install-ent-windows-nocompass
72+
source:
73+
file: release-base.yaml
74+
ref: _install-windows-ent-nocompass
75+
replacement:
76+
location: 'C:\Program Files\MongoDB\Server\{+version+}\'
5677
...

‎source/includes/steps-configure-windows-service-for-mongodb.yaml

Lines changed: 42 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,59 @@
11
stepnum: 1
2+
level: 4
23
inherit:
3-
file: steps-create-manually-windows-service-for-mongodb.yaml
4-
ref: open-command-prompt
5-
---
6-
stepnum: 2
7-
inherit:
8-
file: steps-create-manually-windows-service-for-mongodb.yaml
4+
file: steps-run-mongodb-on-windows.yaml
95
ref: create-directories
6+
pre: |
7+
8+
If you have not created the data and log directories for your
9+
MongoDB server, you must create them before running |mdb-edition| as
10+
a Windows service.
1011
---
11-
stepnum: 3
12+
stepnum: 2
13+
level: 4
1214
inherit:
1315
file: steps-create-manually-windows-service-for-mongodb.yaml
1416
ref: create-configuration-file
1517
---
1618
title: Install the MongoDB service.
17-
stepnum: 4
19+
stepnum: 3
20+
level: 4
1821
ref: mongodb-service
19-
pre: |
20-
.. important::
22+
content: |
2123
22-
Run all of the following commands in :guilabel:`Command Prompt` with
23-
"Administrative Privileges".
24-
action:
25-
- pre: |
26-
Install the MongoDB service by starting :binary:`~bin.mongod.exe`
27-
with the ``--install`` option and the ``-config``
28-
option to specify the previously created configuration file.
29-
language: powershell
30-
copyable: true
31-
code: |
32-
"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe" ^
24+
Install the MongoDB service by starting :binary:`~bin.mongod.exe`
25+
with the ``--install`` option and the ``-config``
26+
option to specify the previously created configuration file.
27+
28+
.. code-block::
29+
30+
"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe" ^
3331
--config "C:\Program Files\MongoDB\Server\{+version+}\mongod.cfg" ^
3432
--install
35-
post: |
33+
3634
To use an alternate :setting:`dbpath`, specify the path in the
3735
configuration file (e.g. ``C:\mongodb\mongod.cfg``) or
38-
on the command line with the :option:`--dbpath <mongod --dbpath>` option.
36+
on the command line with the :option:`--dbpath <mongod --dbpath>`
37+
option.
38+
39+
.. note::
3940
40-
If needed, you can install services for multiple instances of
41-
:binary:`~bin.mongod.exe` or :binary:`~bin.mongos.exe`. Install each service
42-
with a unique :option:`--serviceName <mongod.exe --serviceName>` and
43-
:option:`--serviceDisplayName <mongod.exe --serviceDisplayName>`. Use
44-
multiple instances only when sufficient system resources exist and your
45-
system design requires it.
41+
You can install services for multiple instances of
42+
:binary:`~bin.mongod.exe` or :binary:`~bin.mongos.exe` on a
43+
single host. Install each service with a unique
44+
:option:`--serviceName <mongod.exe --serviceName>` and
45+
:option:`--serviceDisplayName <mongod.exe --serviceDisplayName>`.
46+
Use multiple instances only when sufficient system resources
47+
exist and your system design requires it.
4648
---
47-
stepnum: 5
49+
stepnum: 4
50+
level: 4
4851
inherit:
4952
file: steps-create-manually-windows-service-for-mongodb.yaml
5053
ref: start-mongodb-service
5154
---
52-
stepnum: 6
55+
stepnum: 5
56+
level: 4
5357
source:
5458
file: steps-run-mongodb-on-linux.yaml
5559
ref: verify
@@ -66,11 +70,12 @@ post: |
6670
ignore these warnings during your initial evaluation of MongoDB.
6771
---
6872
title: Connect to MongoDB.
69-
stepnum: 7
73+
stepnum: 6
74+
level: 4
7075
ref: connect
7176
pre: |
72-
To connect to MongoDB through the :binary:`mongo.exe <bin.mongo>` shell,
73-
open another :guilabel:`Command Prompt`.
77+
To connect to MongoDB through the :binary:`mongo.exe <bin.mongo>`
78+
shell, open another :guilabel:`Command Prompt`.
7479
action:
7580
copyable: true
7681
language: powershell
@@ -80,8 +85,9 @@ post: |
8085
If you want to develop applications using .NET, see the documentation
8186
of :ecosystem:`C# and MongoDB </drivers/csharp>` for more information.
8287
---
83-
title: Stop or remove the MongoDB service as needed.
84-
stepnum: 8
88+
title: Stop or remove the MongoDB service.
89+
stepnum: 7
90+
level: 4
8591
ref: stop
8692
action:
8793
- pre: |

0 commit comments

Comments
 (0)