0
0
mirror of https://github.com/mongodb/mongo.git synced 2024-12-01 09:32:32 +01:00
mongodb/README.md

93 lines
2.0 KiB
Markdown
Raw Normal View History

2021-06-17 22:14:37 +02:00
# ![Logo](docs/leaf.svg) MongoDB README
Welcome to MongoDB!
## Components
- `mongod` - The database server.
- `mongos` - Sharding router.
- `mongo` - The database shell (uses interactive javascript).
## Utilities
`install_compass` - Installs MongoDB Compass for your platform.
## 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 mongo javascript shell connects to localhost and test database by default:
$ ./mongo
> 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/. Use the shell
(`mongo`) for administrative tasks.
## 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.
## Documentation
https://docs.mongodb.com/manual/
## Cloud Hosted MongoDB
https://www.mongodb.com/cloud/atlas
## Forums
- https://community.mongodb.com
Technical questions about using MongoDB.
- https://community.mongodb.com/c/server-dev
Technical questions about building and developing MongoDB.
## Learn MongoDB
https://university.mongodb.com/
## 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.