Skip to content

DOCSP-3509: windows community install - separate into wizard vs msiexec #3497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config/sphinx_local.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ theme:
- /tutorial/update-documents
- /tutorial/enable-authentication
- /tutorial/install-mongodb-on-ubuntu
- /tutorial/install-mongodb-on-windows
- /tutorial/install-mongodb-on-red-hat
- /tutorial/install-mongodb-on-debian
- /tutorial/install-mongodb-on-suse
Expand Down
Binary file added source/images/windows-installer-install-only.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,14 @@ replacement:
mongodb: ":guilabel:`MongoDB Enterprise Server`"
archive: ":guilabel:`Archived releases`"
---
title: "Open Windows Explorer/File Explorer."
title: "Run the MongoDB installer."
stepnum: 2
level: 4
ref: open-windows-explorer
---
title: "Navigate to the directory in which you downloaded the MongoDB installer."
stepnum: 3
inherit:
file: steps-install-mongodb-on-windows-interactive.yaml
ref: change-to-download-directory
---
title: "Double-click the ``.msi`` file."
stepnum: 4
level: 4
ref: run-windows-installer
ref: run-windows-installer
---
title: "Follow the |mdb-edition| installation wizard."
stepnum: 5
stepnum: 3
level: 4
inherit:
file: steps-install-mongodb-on-windows-interactive.yaml
Expand Down
173 changes: 106 additions & 67 deletions source/includes/steps-install-mongodb-on-windows-interactive.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@ stepnum: 1
level: 4
ref: download-mongodb
content: |
a. Open a web browser and visit the |mdb-download-link|.
Download the installer (``.msi``) from the |mdb-download-link|:

#. The Download Center should display {{mongodb}} tab. If not,
a. The Download Center should display {{mongodb}} download information. If not,
select :guilabel:`Server`, then click the {{mongodb}} tab.

#. In the :guilabel:`Version` dropdown, select the version that
corresponds to MongoDB Server |version|. The download center always
displays the latest available point version. For older
point releases, click {{archive}} in the right hand navigation
box.
displays the latest available point version.

#. In the :guilabel:`OS` dropdown, verify that ``Windows 64-bit X64``
is selected.
Expand All @@ -23,83 +21,124 @@ content: |
#. Click :guilabel:`Download`.
replacement:
mongodb: ":guilabel:`MongoDB Community Server`"
archive: ":guilabel:`All version binaries`"
---
title: "Open Windows Explorer/File Explorer."
title: "Run the MongoDB installer"
stepnum: 2
level: 4
ref: open-windows-explorer
---
title: "Navigate to the directory in which you downloaded the MongoDB installer."
stepnum: 3
level: 4
ref: change-to-download-directory
content: |
Change the directory path to where you downloaded the MongoDB
``.msi`` file. By default, this is ``%HOMEPATH%\Downloads``.
From the Windows Explorer/File Explorer:

a. Navigate to the directory in which you downloaded the MongoDB installer (``.msi`` file).
By default, this is ``%HOMEPATH%\Downloads``.

#. Double-click the ``.msi`` file.

---
title: "Double-click the ``.msi`` file."
stepnum: 4
level: 4
ref: run-windows-installer
---
title: "Follow the |mdb-edition| installation wizard."
stepnum: 5
stepnum: 3
level: 4
ref: follow-install-wizard
content: |

The wizard steps you through the installation of MongoDB and MongoDB
Compass.

You can choose either the :guilabel:`Complete` or :guilabel:`Custom`
setup type. If you choose the :guilabel:`Custom` installation
option, you may specify an installation directory. MongoDB has no
other system dependencies. You can install and run MongoDB from any
directory.

Starting in MongoDB 4.0, you can, by default, configure and start
MongoDB as a service during the install, and the MongoDB service is
started upon successful installation.

.. figure:: /images/windows-installer.png
:alt: Image of the MongoDB Installer wizard. Optional Windows Service Configuration.
:figwidth: 496px

- If you choose not to configure MongoDB as a service, uncheck the
:guilabel:`Install MongoD as a Service`.
a. :guilabel:`Choose Setup Type`
You can choose either the :guilabel:`Complete` (recommended for
most users) or :guilabel:`Custom` setup type. If you choose the
:guilabel:`Custom` installation option, you may specify which
executables are installed and where.

- If you choose to configure MongoDB as a service, you can:

- Specify to run the service as one of the following users:

- Network Service user; i.e. a Windows user account that is
built-in to Windows
#. :guilabel:`Service Configuration`
Starting in MongoDB 4.0, you can set up MongoDB as a service
during the install or just install. Click on the appropriate
tab for instructions.

.. tabs::

tabs:

- id: service
name: MongoDB Service
content: |

The following installs and configures MongoDB as a
service. To install only, click on the appropriate tab.

Starting in MongoDB 4.0, you can configure
and start MongoDB as a service during the install, and
the MongoDB service is started upon successful
installation.

.. figure:: /images/windows-installer.png
:alt: Image of the MongoDB Installer wizard - Service Configuration.
:figwidth: 496px


- Select :guilabel:`Install MongoD as a Service` MongoDB as a service.

- Select to :guilabel:`Run the service as` one of the following users:

- Network Service user (Default); i.e. a Windows user
account that is built-in to Windows

- Local or domain user:

- For an existing local user account, specify a
period (i.e. ``.``) for the :guilabel:`Account
Domain` and specify the :guilabel:`Account Name` and
the :guilabel:`Account Password` for the user.

- For an existing domain user, specify the
:guilabel:`Account Domain`, the
:guilabel:`Account Name` and the
:guilabel:`Account Password` for that user.

- :guilabel:`Service Name`. Specify the service
name. Default name is ``MongoDB``. If you already
have a service with the specified name, you must
choose another name.

- :guilabel:`Data Directory`. Specify the data
directory, which corresponds to the
:option:`--dbpath <mongod --dbpath>`. If the
directory does not exist, the installer will
create the directory and sets the directory access
to the service user.

- :guilabel:`Log Directory`. Specify the Log
directory, which corresponds to the
:option:`--logpath <mongod --logpath>`. If the
directory does not exist, the installer will
create the directory and sets the directory access
to the service user.

- id: mongodb
name: MongoDB
content: |

The following installs MongoDB only and does not
configure MongoDB as a service. To install and configure
MongoDB as a service, click on the appropriate tab.

If you choose not to configure MongoDB as a service,
uncheck the :guilabel:`Install MongoD as a Service`.

.. figure:: /images/windows-installer-install-only.png
:alt: Image of the MongoDB Installer wizard. Not as a service.
:figwidth: 498px

#. :guilabel:`Install MongoDB Compass`
To also install `MongoDB Compass
<https:///www.mongodb.com/products/compass>`__, ensure that
:guilabel:`Install MongoDB Compass` is selected (Default).

#. When ready, click :guilabel:`Install`.

- Local or domain user:

- For an existing local user account, specify a period (i.e.
``.``) for the :guilabel:`Account Domain` and the
:guilabel:`Account Name` and the :guilabel:`Account
Password` for the user.

- For an existing domain user, specify the :guilabel:`Account
Domain`, the :guilabel:`Account Name` and the
:guilabel:`Account Password` for that user.

- Specify the Service Name. If you already have a service with the
specified name, you must choose another name.

- Specify the Data directory, which corresponds to the
:option:`--dbpath <mongod --dbpath>`. If the directory does not
exist, the installer will create the directory and sets the
directory access to the service user.

- Specify the Log directory, which corresponds to the
:option:`--logpath <mongod --logpath>`. If the directory does not
exist, the installer will create the directory and sets the
directory access to the service user.


If you installed and configured MongoDB as a service, the MongoDB
service is started upon successful installation. MongoDB is
configured using the configuration file :file:`<install
directory>\\bin\\mongod.cfg`.

...
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,19 @@ source:
file: steps-install-mongodb-on-windows-interactive.yaml
ref: download-mongodb
replacement:
mongodb: ":guilabel:`MongoDB Enterprise Server`"
mongodb: ":guilabel:`MongoDB Community Server`"
---
title: Run the Windows Installer from the Windows Command Interpreter.
stepnum: 2
level: 4
ref: install
pre: |

.. important::

You must open the command interpreter (not Powershell) as an
:guilabel:`Administrator`.

To install all MongoDB binaries, including MongoDB Compass, to the
default installation directory, go to the directory containing the
``.msi`` installation binary and invoke:
Expand Down
45 changes: 14 additions & 31 deletions source/includes/steps-run-mongodb-on-windows.yaml
Original file line number Diff line number Diff line change
@@ -1,50 +1,33 @@
title: "Create database and log directories."
title: "Create database directory."
stepnum: 1
ref: create-directories
content: |

MongoDB requires a :term:`data directory <dbpath>` to store all
data. MongoDB's default data directory path is the absolute path
``\data\db`` on the drive from which you start MongoDB.
Create the :term:`data directory <dbpath>` where MongoDB stores data.
MongoDB's default data directory path is the absolute path
``\data\db`` on the drive from which you start MongoDB.

Invoke the following command in the :guilabel:`Command Interpreter`
to create these directories:
From the :guilabel:`Command Interpreter`, create the data directories:

.. code-block:: bat

md "\data\db" "\data\log"

.. note::
The quotations marks matter when creating more than one directory
path at the same time.

cd C:\
md "\data\db"

---
title: Start your MongoDB database.
stepnum: 2
ref: start
content: |

To start MongoDB, invoke :binary:`~bin.mongod.exe`.

.. example::
To start MongoDB, run :binary:`~bin.mongod.exe`.

From the :guilabel:`Command Interpreter`:

.. code-block:: bat
.. code-block:: bat

"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe" --dbpath="c:\data\db"
"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe" --dbpath="c:\data\db"

The :option:`--dbpath <mongod --dbpath>` option points to your
database directory.

.. note::

If your path includes spaces, enclose the entire path in double
quotes:

.. code-block:: bat

"C:\Program Files\MongoDB\Server\{+version+}\bin\mongod.exe" --dbpath "d:\test\mongo db data"

If the MongoDB database server is running correctly, the
:guilabel:`Command Interpreter` displays:
Expand Down Expand Up @@ -73,9 +56,9 @@ title: Connect to MongoDB.
stepnum: 3
ref: connect
content: |
To connect to MongoDB through the
:binary:`mongo.exe <bin.mongo>` shell, open another
:guilabel:`Command Interpreter`.
To connect the
:binary:`mongo.exe <bin.mongo>` shell to the MongoDB instance, open another
:guilabel:`Command Interpreter` with Administrative privileges and run:

.. code-block:: bat

Expand Down
Loading