Skip to content

Commit c48aa5a

Browse files
committed
DOCSP-3509: windows community install - separate into wizard vs msiexec
1 parent 3b4e41f commit c48aa5a

8 files changed

+386
-207
lines changed

config/sphinx_local.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ theme:
9898
- /tutorial/update-documents
9999
- /tutorial/enable-authentication
100100
- /tutorial/install-mongodb-on-ubuntu
101+
- /tutorial/install-mongodb-on-windows
101102
- /tutorial/install-mongodb-on-red-hat
102103
- /tutorial/install-mongodb-on-debian
103104
- /tutorial/install-mongodb-on-suse
36.2 KB
Loading

source/includes/steps-install-mongodb-on-windows-enterprise-interactive.yaml

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,14 @@ replacement:
99
mongodb: ":guilabel:`MongoDB Enterprise Server`"
1010
archive: ":guilabel:`Archived releases`"
1111
---
12-
title: "Open Windows Explorer/File Explorer."
12+
title: "Run the MongoDB installer."
1313
stepnum: 2
14-
level: 4
15-
ref: open-windows-explorer
16-
---
17-
title: "Navigate to the directory in which you downloaded the MongoDB installer."
18-
stepnum: 3
1914
inherit:
2015
file: steps-install-mongodb-on-windows-interactive.yaml
21-
ref: change-to-download-directory
22-
---
23-
title: "Double-click the ``.msi`` file."
24-
stepnum: 4
25-
level: 4
26-
ref: run-windows-installer
16+
ref: run-windows-installer
2717
---
2818
title: "Follow the |mdb-edition| installation wizard."
29-
stepnum: 5
19+
stepnum: 3
3020
level: 4
3121
inherit:
3222
file: steps-install-mongodb-on-windows-interactive.yaml

source/includes/steps-install-mongodb-on-windows-interactive.yaml

Lines changed: 106 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,14 @@ stepnum: 1
33
level: 4
44
ref: download-mongodb
55
content: |
6-
a. Open a web browser and visit the |mdb-download-link|.
6+
Download the installer (``.msi``) from the |mdb-download-link|:
77
8-
#. The Download Center should display {{mongodb}} tab. If not,
8+
a. The Download Center should display {{mongodb}} download information. If not,
99
select :guilabel:`Server`, then click the {{mongodb}} tab.
1010
1111
#. In the :guilabel:`Version` dropdown, select the version that
1212
corresponds to MongoDB Server |version|. The download center always
13-
displays the latest available point version. For older
14-
point releases, click {{archive}} in the right hand navigation
15-
box.
13+
displays the latest available point version.
1614
1715
#. In the :guilabel:`OS` dropdown, verify that ``Windows 64-bit X64``
1816
is selected.
@@ -23,83 +21,124 @@ content: |
2321
#. Click :guilabel:`Download`.
2422
replacement:
2523
mongodb: ":guilabel:`MongoDB Community Server`"
26-
archive: ":guilabel:`All version binaries`"
2724
---
28-
title: "Open Windows Explorer/File Explorer."
25+
title: "Run the MongoDB installer"
2926
stepnum: 2
3027
level: 4
31-
ref: open-windows-explorer
32-
---
33-
title: "Navigate to the directory in which you downloaded the MongoDB installer."
34-
stepnum: 3
35-
level: 4
36-
ref: change-to-download-directory
3728
content: |
38-
Change the directory path to where you downloaded the MongoDB
39-
``.msi`` file. By default, this is ``%HOMEPATH%\Downloads``.
29+
From the Windows Explorer/File Explorer:
30+
31+
a. Navigate to the directory in which you downloaded the MongoDB installer (``.msi`` file).
32+
By default, this is ``%HOMEPATH%\Downloads``.
33+
34+
#. Double-click the ``.msi`` file.
4035
41-
---
42-
title: "Double-click the ``.msi`` file."
43-
stepnum: 4
44-
level: 4
4536
ref: run-windows-installer
4637
---
4738
title: "Follow the |mdb-edition| installation wizard."
48-
stepnum: 5
39+
stepnum: 3
4940
level: 4
5041
ref: follow-install-wizard
5142
content: |
5243
5344
The wizard steps you through the installation of MongoDB and MongoDB
5445
Compass.
5546
56-
You can choose either the :guilabel:`Complete` or :guilabel:`Custom`
57-
setup type. If you choose the :guilabel:`Custom` installation
58-
option, you may specify an installation directory. MongoDB has no
59-
other system dependencies. You can install and run MongoDB from any
60-
directory.
61-
62-
Starting in MongoDB 4.0, you can, by default, configure and start
63-
MongoDB as a service during the install, and the MongoDB service is
64-
started upon successful installation.
65-
66-
.. figure:: /images/windows-installer.png
67-
:alt: Image of the MongoDB Installer wizard. Optional Windows Service Configuration.
68-
:figwidth: 496px
69-
70-
- If you choose not to configure MongoDB as a service, uncheck the
71-
:guilabel:`Install MongoD as a Service`.
47+
a. :guilabel:`Choose Setup Type`
48+
You can choose either the :guilabel:`Complete` (recommended for
49+
most users) or :guilabel:`Custom` setup type. If you choose the
50+
:guilabel:`Custom` installation option, you may specify which
51+
executables are installed and where.
7252
73-
- If you choose to configure MongoDB as a service, you can:
74-
75-
- Specify to run the service as one of the following users:
76-
77-
- Network Service user; i.e. a Windows user account that is
78-
built-in to Windows
53+
#. :guilabel:`Service Configuration`
54+
Starting in MongoDB 4.0, you can set up MongoDB as a service
55+
during the install or just install. Click on the appropriate
56+
tab for instructions.
57+
58+
.. tabs::
59+
60+
tabs:
61+
62+
- id: service
63+
name: MongoDB Service
64+
content: |
65+
66+
The following installs and configures MongoDB as a
67+
service. To install only, click on the appropriate tab.
68+
69+
Starting in MongoDB 4.0, you can configure
70+
and start MongoDB as a service during the install, and
71+
the MongoDB service is started upon successful
72+
installation.
73+
74+
.. figure:: /images/windows-installer.png
75+
:alt: Image of the MongoDB Installer wizard - Service Configuration.
76+
:figwidth: 496px
77+
78+
79+
- Select :guilabel:`Install MongoD as a Service` MongoDB as a service.
80+
81+
- Select to :guilabel:`Run the service as` one of the following users:
82+
83+
- Network Service user (Default); i.e. a Windows user
84+
account that is built-in to Windows
85+
86+
- Local or domain user:
87+
88+
- For an existing local user account, specify a
89+
period (i.e. ``.``) for the :guilabel:`Account
90+
Domain` and specify the :guilabel:`Account Name` and
91+
the :guilabel:`Account Password` for the user.
92+
93+
- For an existing domain user, specify the
94+
:guilabel:`Account Domain`, the
95+
:guilabel:`Account Name` and the
96+
:guilabel:`Account Password` for that user.
97+
98+
- :guilabel:`Service Name`. Specify the service
99+
name. Default name is ``MongoDB``. If you already
100+
have a service with the specified name, you must
101+
choose another name.
102+
103+
- :guilabel:`Data Directory`. Specify the data
104+
directory, which corresponds to the
105+
:option:`--dbpath <mongod --dbpath>`. If the
106+
directory does not exist, the installer will
107+
create the directory and sets the directory access
108+
to the service user.
109+
110+
- :guilabel:`Log Directory`. Specify the Log
111+
directory, which corresponds to the
112+
:option:`--logpath <mongod --logpath>`. If the
113+
directory does not exist, the installer will
114+
create the directory and sets the directory access
115+
to the service user.
116+
117+
- id: mongodb
118+
name: MongoDB
119+
content: |
120+
121+
The following installs MongoDB only and does not
122+
configure MongoDB as a service. To install and configure
123+
MongoDB as a service, click on the appropriate tab.
124+
125+
If you choose not to configure MongoDB as a service,
126+
uncheck the :guilabel:`Install MongoD as a Service`.
127+
128+
.. figure:: /images/windows-installer-install-only.png
129+
:alt: Image of the MongoDB Installer wizard. Not as a service.
130+
:figwidth: 498px
131+
132+
#. :guilabel:`Install MongoDB Compass`
133+
To also install `MongoDB Compass
134+
<https:///www.mongodb.com/products/compass>`__, ensure that
135+
:guilabel:`Install MongoDB Compass` is selected (Default).
136+
137+
#. When ready, click :guilabel:`Install`.
79138
80-
- Local or domain user:
81-
82-
- For an existing local user account, specify a period (i.e.
83-
``.``) for the :guilabel:`Account Domain` and the
84-
:guilabel:`Account Name` and the :guilabel:`Account
85-
Password` for the user.
86-
87-
- For an existing domain user, specify the :guilabel:`Account
88-
Domain`, the :guilabel:`Account Name` and the
89-
:guilabel:`Account Password` for that user.
90-
91-
- Specify the Service Name. If you already have a service with the
92-
specified name, you must choose another name.
93-
94-
- Specify the Data directory, which corresponds to the
95-
:option:`--dbpath <mongod --dbpath>`. If the directory does not
96-
exist, the installer will create the directory and sets the
97-
directory access to the service user.
98-
99-
- Specify the Log directory, which corresponds to the
100-
:option:`--logpath <mongod --logpath>`. If the directory does not
101-
exist, the installer will create the directory and sets the
102-
directory access to the service user.
103-
104-
139+
If you installed and configured MongoDB as a service, the MongoDB
140+
service is started upon successful installation. MongoDB is
141+
configured using the configuration file :file:`<install
142+
directory>\bin\mongod.cfg`.
143+
105144
...

source/includes/steps-install-mongodb-on-windows-unattended.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,19 @@ source:
66
file: steps-install-mongodb-on-windows-interactive.yaml
77
ref: download-mongodb
88
replacement:
9-
mongodb: ":guilabel:`MongoDB Enterprise Server`"
9+
mongodb: ":guilabel:`MongoDB Community Server`"
1010
---
1111
title: Run the Windows Installer from the Windows Command Interpreter.
1212
stepnum: 2
1313
level: 4
1414
ref: install
1515
pre: |
1616
17+
.. important::
18+
19+
You must open the command interpreter (not Powershell) as an
20+
:guilabel:`Administrator`.
21+
1722
To install all MongoDB binaries, including MongoDB Compass, to the
1823
default installation directory, go to the directory containing the
1924
``.msi`` installation binary and invoke:

source/includes/steps-run-mongodb-on-windows.yaml

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,33 @@
1-
title: "Create database and log directories."
1+
title: "Create database directory."
22
stepnum: 1
33
ref: create-directories
44
content: |
55
6-
MongoDB requires a :term:`data directory <dbpath>` to store all
7-
data. MongoDB's default data directory path is the absolute path
8-
``\data\db`` on the drive from which you start MongoDB.
6+
Create the :term:`data directory <dbpath>` where MongoDB stores data.
7+
MongoDB's default data directory path is the absolute path
8+
``\data\db`` on the drive from which you start MongoDB.
99
10-
Invoke the following command in the :guilabel:`Command Interpreter`
11-
to create these directories:
10+
From the :guilabel:`Command Interpreter`, create the data directories:
1211
1312
.. code-block:: bat
14-
15-
md "\data\db" "\data\log"
16-
17-
.. note::
18-
The quotations marks matter when creating more than one directory
19-
path at the same time.
13+
14+
cd C:\
15+
md "\data\db"
2016
2117
---
2218
title: Start your MongoDB database.
2319
stepnum: 2
2420
ref: start
2521
content: |
2622
27-
To start MongoDB, invoke :binary:`~bin.mongod.exe`.
28-
29-
.. example::
23+
To start MongoDB, run :binary:`~bin.mongod.exe`.
3024
31-
From the :guilabel:`Command Interpreter`:
32-
33-
.. code-block:: bat
25+
.. code-block:: bat
3426
35-
"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe" --dbpath="c:\data\db"
27+
"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe" --dbpath="c:\data\db"
3628
3729
The :option:`--dbpath <mongod --dbpath>` option points to your
3830
database directory.
39-
40-
.. note::
41-
42-
If your path includes spaces, enclose the entire path in double
43-
quotes:
44-
45-
.. code-block:: bat
46-
47-
"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe" --dbpath "d:\test\mongo db data"
4831
4932
If the MongoDB database server is running correctly, the
5033
:guilabel:`Command Interpreter` displays:
@@ -73,9 +56,9 @@ title: Connect to MongoDB.
7356
stepnum: 3
7457
ref: connect
7558
content: |
76-
To connect to MongoDB through the
77-
:binary:`mongo.exe <bin.mongo>` shell, open another
78-
:guilabel:`Command Interpreter`.
59+
To connect the
60+
:binary:`mongo.exe <bin.mongo>` shell to the MongoDB instance, open another
61+
:guilabel:`Command Interpreter` with Administrative privileges and run:
7962
8063
.. code-block:: bat
8164

0 commit comments

Comments
 (0)