What is MongoDB?
MongoDB is a free and open-source big-data document database that stores data in flexible, JSON-like documents. Opmantek chose MongoDB as our back-end database because it is fast and reliable, all with relatively low overhead.
Which MongoDB version should be used?
It is possible to continue to use MongoDB 2.6 for certain products, but the 3.x versions bring in a number of important performance improvements and some products strictly require these capabilities. MongoDB 3.6 is not supported by our applications at this time. Version 2.4 is no longer supported.
Please see our Product Compatibility page for details regarding what product releases work (best) with which MongoDB versions.
The installer in our recent product releases offers to install version 3.4 of MongoDB for you if none is present on your server, and no manual configuration should be required.
If you do already have MongoDB 3.x on your system, then the installer (for opmantek application releases after Jan 2018) will offer to upgrade MongoDB to version 3.4 for you.
If you have MongoDB 2.x, then you will have to upgrade manually; we HIGHLY RECOMMEND that you follow the official documentation for MongoDB upgrades
- that you cannot skip major versions for upgrades (i.e. from 2.4 you must upgrade to 2.6 first, then to 3.0, then to 3.2 and finally to 3.4) ,
- and that you must upgrade the MongoDB authorization scheme before 3.0 will work, as documented on this page.
Besides these caveats we've not encountered any major problems with upgrades in our lab tests (tested on CentOS/RedHat 6, Debian 7, Ubuntu 14).
Configuring MongoDB Authentication/Authorization with the setup_mongodb.pl Script
All Opmantek applications that require MongoDB ship with a configuration tool for MongoDB, named
bin/setup_mongodb.pl. It's recommended that you use this tool for setting up MongoDB authentication, as it can deal with separate per-product MongoDB instances and simplifies the procedure substantially. The relevant product installers already offer to run the tool during installation and upgrades, hence you rarely need to run it manually.
To use the tool manually, simply run it as root and follow the prompts (if any):
If required the tool will prompt you for database credentials and advise on remote-vs-local operation, as well as authenticated-vs-nonauthenticated modes. The MongoDB setup helper can be run repeatedly with no adverse effects.
Resetting Databases with the setup_mongodb.pl Script
Should you want to reset one or more product databases to their initial empty state, you will need version 2.54 (or newer) of
setup_mongodb.pl. With that version you may pass the extra arguments "drop=<dbname1>,<dbname2> confirm=YES", and
setup_mongodb will completely empty the named databases. Please note that this is an irrevocable operation and may lead to substantial data loss if you pick the wrong database to drop!
You can find the database names in the standard configuration file
conf/opCommon.nmis, under the keys
Please note that the database named by the key
db_name (default name: "
nmis") is shared and used by multiple products and therefore dropping this database would affect multiple products!
Deprecated - Historic Installation Instructions
As of September 2015 the installation instructions below are no longer applicable; the installer will take care of installation and initial configuration of MongoDB for you.
Debian 7.0 (aka Wheezy) ships with a much older version, which should work but very likely won't provide adequate performance. However, the mongodb packages in wheezy-backports are fine, as are the versions in Testing/Jessie and Unstable. First make sure that you have Backports or Testing/Unstable enabled, then use
su to run the following command as
As an alternative you can also download Debian-ready packages from the MongoDB site, which do however use a different package name.
Recent versions of Ubuntu come with suitable MongoDB packages. Use
su to become the
root user, then run the following command:
Installing the mongodb-server package will result in a working, automatically started MongoDB with no authentication.
Download MongoDB from the Website at https://www.mongodb.org/downloads.
Opmantek Setup for MongoDB
For Debian-derived distributions the default configuration is fine, but you might still want to adjust the database storage area. The configuration file is
/etc/mongodb.conf, and the init script is in
For other systems, check that the location in the provided init script is where you want the database to store its files (the default is mongodbpath=/var/mongodb for the original version):
NOTE - this file will only exist AFTER you have run an installer which requires mongodb.
After you have the location you prefer, the next set of commands will put a start-up script in the correct location, register the script and then start mongo (before doing this make sure to consider how much data you plan to store. Each application has different needs and how you plan to use the application will have an enormous impact on the space required by the database). The last command here starts MongoDB, the first time it runs it can take some time to do its pre-allocation of database and journal files. This will depend on the performance of your storage.
If this is a Debian-derived system and you made config changes, then your mongod will already be running and you need to restart it like this:
Manual MongoDB Authentication Configuration
Please note that these instructions are applicable only for MongoDB 2.4 and as such are of historic interest only.
Should using the
setup_mongodb.pl helper not be an option for you, then you can still prime the database(s) manually for Opmantek use.
Load the mongo CLI, create the user for the admin DB, authenticate, then do the same for the NMIS db (change the username and password to your liking):
NB: Now make sure that the user/pass matches the config in opCommon.nmis.
If you don't require authentication simply skip the steps above and set the username in the configuration file to ''