## 1. Project Overview & Quickstart (mongodb/mongo)

## File: README.md

#  MongoDB README

Welcome to MongoDB!

## Components

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

## Download MongoDB

- 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

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

## Building

See [Building MongoDB](docs/building.md).

## Running

For command line options invoke:

```bash
$ ./mongod --help
```

To run a single server database:

```bash
$ 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:

```bash
$ ./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](buildscripts/packager.py) script.
This will generate RPM and Debian packages.

## Learn MongoDB

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

## Cloud Hosted MongoDB

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

## Forums

- 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

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](LICENSE-Community.txt). 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

# MongoDB Server Documentation

This is just some internal documentation.

For the full MongoDB docs, please see [mongodb.org](http://www.mongodb.org/)

- [Batons](baton.md)
- [Build System](build_system.md)
- [Build System Reference](build_system_reference.md)
- [Building MongoDB](building.md)
- [Command Dispatch](command_dispatch.md)
- [Contextual Singletons](contexts.md)
- [Egress Networking](egress_networking.md)
- [Exception Architecture](exception_architecture.md)
- [Fail Points](fail_points.md)
- [Futures and Promises](futures_and_promises.md)
- [Interface Definition Language (IDL)](idl.md)
- [Load Balancer Support](load_balancer_support.md)
- [Memory Management](memory_management.md)
- [Parsing Stack Traces](parsing_stack_traces.md)
- [Primary-only Services](primary_only_service.md)
- [Reader-Writer Mutex Types](rwmutex.md)
- [Security Architecture Guide](security_guide.md)
- [Server Parameters](server_parameters.md)
- [String Manipulation](string_manipulation.md)
- [Thread Pools](thread_pools.md)
- [MongoDB Voluntary Product Accessibility Template® (VPAT™)](vpat.md)

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

## File: README.md

# Docs Monorepo

## Selecting PR Template

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:

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

## Context7

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

=====================
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
----------

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

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

License
-------

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 `docs@mongodb.com
<mailto:docs@mongodb.com>`_.

-- The MongoDB Documentation Team