MongoDB installation procedure

MongoDB can be installed separately on a server that can be different from the node.js server (in this case, the installation can be done by using this procedure). But it can also be installed in a single step with the Syracuse platform installation (this is the embedded Syracuse+MongoDB installation). This is described in the Syracuse installation description document.

To launch this separate installation, double-click the '.jar' file in the SafeX3Mongodb folder.

Full installation

The first screen allows to choose the installation language:
The second screen is a welcome page:
This screen is followed by a description page of the components that will be installed:
The next screen is the license agreement that must be accepted if you want to continue the installation:
The next screen gives the choice between proceeding with a new installation, or changing the characteristics of an existing installation. The new installation should be chosen:
  • the first time the platform is installed on a server.
  • if you want to switch from a manual installation (done in 7.0) to an automatic installation.
  • if you want to switch from an installation done in 8.0 to an installation that manages security through certificates.
Changing the characteristics of an old installation is possible because, at a given point of the installation, it will be possible to connect to the previous MongoDB instance and to transfer the data on the newly created instance.
Let's first see what happens when a new installation is chosen.The setup dialog asks for the root directory associated to MongoDb installation files. If the directory does not exist, it is possible to create it:
The packages to be installed can be selected. The only mandatory package contains the core file to run MonoDB:
Now, the information needed to configure the service are requested, if the corresponding checkbox is set (recommended). The information entered is the following:
  • the MongoDB node identifier (must be unique on a server).
  • the different path for the files related to the MongoDB installation. By default, sub-directories of the installation directory are proposed: `data` for the data files, `logs` for the log files, and `config` for the configuration files.
  • the service port number used to connect to MongoDB (27017 by default).
  • A final check box that allows to enable ipv6 server. Using this supposes that the server itself uses ipv6 address configuration. If this isn't the case, don't check the box.
The next step is related to the service configuration. If the `The server accepts only SSL encrypted connections` checkbox is not set, nothing else has to be entered here.But if the checkbox is set, we need to set-up the certificate that will be used for the secured connection. Two options exist in this case:
  • Either we create certificates with an automated procedure.
  • Or we use existing certificates.
Let's first see what happens in the first case.
The first information to be entered here is the passphrase associated to the master certificate (CA) that will be created:
Then, the information related to the data that defines the connection certificate will be entered:
We can now enter the passphrase associated to the connection certificate, as well as the server associated. Take care that the server path must be the complete path including the full qualified domain name, otherwise further connections will be refused:
The next step allows to initialize the MongoDB database from another instance. If the check-box is not set, nothing else has to be entered; if the check-box is set, it corresponds to the case where an old version was present (V7 or V8 installed without certificate). The data associated to the previous version will then be transferred, as soon as the right host name and the corresponding port are entered:
The screen that dispays at the next step summarizes the options entered for this installation. Check them carefully and go back if anything was wrongly entered.
Otherwise, the installation will run with several steps. At the end, a summarized page dispays what has been done (installation plus a test of connectivity):
The installation is now finished. Note that an uninstallation script has been generated, that will be used if you want to desinstall the software. A last option is available, that generates an automated installation script. This script is an XML file that stores the answers given to all the previous dialog boxes.This file can be modified and reused in order to run automatically a setup, for instance on another server.Running automatically an installation script associated to an XML answer file (let's call it responses.xml) will be done by running the following command (in a shell with the path to java.exe set, setup.jar being accessible):`java -jar setup.jar responses.xml`

Re-installation

Let's go back to the case where an installation modification is requested; We have, in this case, to select the MongoDB instance we want to modify:
The next screen allows to modify the previous entered options (re-configure the service, and then change the service number if necessary and change the ipv6 option).
The next screen allows to change the SSL option (enable it if it was disabled, or disable it if it was enabled). If the SSL option is set, you can also choose to recreate the certificates (for instance if the certificate and/or the passphrase was lost). In this case, you will have to enter again the path to the certificate files, and have the choice between a simplified installation or reusing an existing certificate:The procedure will continue to run as previously until its end.

Comment

Take note of the server name for MongoDB database and the corresponding port number that have been setup, and keep this information at hand while launching the 9 web server installation.