mongo Documentation

1. Project Overview & Quickstart (mongodb/mongo) Copy Chapter

File: README.md Copy Chapter

MongoDB README

Welcome to MongoDB!

Components Copy Chapter

• mongod - The database server.
• mongos - Sharding router.

Download MongoDB Copy Chapter

• https://www.mongodb.com/try/download/community
• Using homebrew brew tap mongodb/brew
• Using docker image docker pull mongodb/mongodb-community-server

Download the MongoDB Shell Copy Chapter

• https://www.mongodb.com/try/download/shell
• Using homebrew brew install mongosh

Building Copy Chapter

See Building MongoDB.

Running Copy Chapter

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 Copy Chapter

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 Copy Chapter

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

Bug Reports Copy Chapter

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

Packaging Copy Chapter

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

Learn MongoDB Copy Chapter

• Documentation - https://docs.mongodb.com/manual/
• Developer Center - https://www.mongodb.com/developer/
• MongoDB University - https://learn.mongodb.com

Cloud Hosted MongoDB Copy Chapter

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

Forums Copy Chapter

• https://mongodb.com/community/forums/

  Technical questions about using MongoDB.

• https://mongodb.com/community/forums/c/server-dev

  Technical questions about building and developing MongoDB.

LICENSE Copy Chapter

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.

File: docs/README.md Copy Chapter

MongoDB Server Documentation

This is just some internal documentation.

For the full MongoDB docs, please see mongodb.org

• Batons
• Build System
• Build System Reference
• Building MongoDB
• Command Dispatch
• Contextual Singletons
• Egress Networking
• Exception Architecture
• Fail Points
• Futures and Promises
• Interface Definition Language (IDL)
• Load Balancer Support
• Memory Management
• Parsing Stack Traces
• Primary-only Services
• Reader-Writer Mutex Types
• Security Architecture Guide
• Server Parameters
• String Manipulation
• Thread Pools
• MongoDB Voluntary Product Accessibility Template® (VPAT™)

2. Official Technical Reference & Guides (mongodb/docs) Copy Chapter

File: README.md Copy Chapter

Docs Monorepo

Selecting PR Template Copy Chapter

When creating a pull request, you can automatically populate the
description with a template by adding a query parameter to the URL. We
provide the following templates:

• Platform changes: Use ?template=platform.md
• Code Example Tests changes: Use ?template=code.md
• Content changes: Use ?template=content.md
• Drivers changes: Use ?template=drivers.md
• Cloud Docs changes: Use ?template=cloud.md
• Agent Skill changes: Use ?template=agent-skill.md

For example:

https://github.com/example/exampleChanges/compare/test?expand=1&template=template.md

Context7 Copy Chapter

The context7.json file in the root of the repository is used to prove our ownership of the MongoDB docs to Context7.

File: README.rst Copy Chapter

===================== MongoDB Documentation

This repository contains a major revision of the MongoDB documentation,
currently accessible at https://www.mongodb.com/docs/manual/. You can build
the documentation locally if you have giza <https://pypi.python.org/pypi/giza>_ installed: ::

python2 -m pip install giza
 git clone https://github.com/mongodb/docs.git
 cd docs/
 make html

If successful, the built HTML files will be located in build//html/ (for example build/master/html/ when on the git master branch).

Contribute Copy Chapter

The MongoDB Documentation Project is governed by the terms of the
MongoDB Contributor Agreement <https://www.mongodb.com/legal/contributor-agreement>_.

To contribute to the documentation,

• If you have not done so already, please sign the MongoDB Contributor Agreement <https://www.mongodb.com/legal/contributor-agreement>_.

• Fork this repository on GitHub and issue a pull request.

Report Issues Copy Chapter

To file issues or requests regarding the documentation, go to the
Documentation Jira Project <https://jira.mongodb.org/browse/DOCS>_.

License Copy Chapter

All documentation is available under the terms of a Creative Commons License <https://creativecommons.org/licenses/by-nc-sa/3.0/>_.

If you have any questions, please contact [email protected] <mailto:[email protected]>_.

-- The MongoDB Documentation Team