mongo README

The project's README from github.com/mongodb/mongo. As one markdown file: README.md.

Logo MongoDB README

Welcome to MongoDB!

Components

Download MongoDB

Download the MongoDB Shell

Building

See Building MongoDB.

Running

For command line options invoke:

$ ./mongod --help

To run a single server database:

$ sudo mkdir -p /data/db
$ ./mongod
$
$ # The mongosh shell connects to localhost and test database by default:
$ ./mongosh
test> help

Installing Compass

You can install compass using the install_compass script packaged with MongoDB:

$ ./install_compass

This will download the appropriate MongoDB Compass package for your platform and install it.

Drivers

Client drivers for most programming languages are available at https://docs.mongodb.com/manual/applications/drivers/.

Bug Reports

See https://github.com/mongodb/mongo/wiki/Submit-Bug-Reports.

Packaging

Packages are created dynamically by the buildscripts/packager.py script. This will generate RPM and Debian packages.

Learn MongoDB

Cloud Hosted MongoDB

https://www.mongodb.com/cloud/atlas

Forums

LICENSE

MongoDB is free and the source is available. Versions released prior to October 16, 2018 are published under the AGPL. All versions released after October 16, 2018, including patch fixes for prior versions, are published under the Server Side Public License (SSPL) v1. See individual files for details which will specify the license applicable to each file. Files subject to the SSPL will be noted in their headers.

mongo (mongodb/mongo)

mongodb
Searching Database…

28.7K ·GitHub
What is this?MongoDB, a widely used NoSQL database. This repo is the database itself: mongod is the server process that stores your data, and mongos is its sharding router.
Is it a program I install, or a library I add to my code?A server you install and run: mongod works as the database server process, and client applications connect to it over the network through drivers.
How do I get it running?On macOS, Homebrew is the documented route: brew tap mongodb/brew. Alternatively pull the official image with docker pull mongodb/mongodb-community-server.
What do I need to actually work with the data?Install the MongoDB Shell (brew install mongosh) to connect from the terminal, and use a client driver in your app — drivers exist for most programming languages.
Is it free to use, or is there a licensing catch?It's free and the source is available, but not under a permissive license: versions released after October 16, 2018 use SSPL v1, older ones AGPL — worth reading carefully if you plan to offer MongoDB to others.
What platforms can I run it on?macOS via Homebrew, Linux via generated RPM and Debian packages, or any machine with Docker. It's a self-hosted server you run on your own infrastructure.
Is there a GUI for browsing the data?Yes — MongoDB Compass. Run the installcompass script packaged with MongoDB and it downloads the appropriate Compass package for your platform and installs it.
Is there a hosted option if I don't want to manage the server?Yes, the README links to a cloud hosted MongoDB offering, so you can use the database without running mongod yourself.
Do most people build it from this repo, or install a package?This repo is the C++ source of the database. Most users install ready builds (Homebrew, Docker, RPM/Debian); compiling from source is documented separately under Building MongoDB.
Creator
mongodb
Size
1.4 GB
Stars
28.7K
Updated
CommitOct 17
Age
17y
Commits · 90 Days