summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Whalen <ian.whalen@gmail.com>2017-02-24 17:42:25 -0500
committerRamon Fernandez <ramon@mongodb.com>2017-05-01 16:02:13 -0400
commit2d10c6b5d04ba604dbc07b92547c3095a93c05f4 (patch)
tree7cea49bc4cbd9c9fdc7ab89dac6c05a0dccbdbc7
parent0ee59992ef9627809e2ff13c608a023fc6b8c909 (diff)
downloadmongo-2d10c6b5d04ba604dbc07b92547c3095a93c05f4.tar.gz
SERVER-21933 Update README
(cherry picked from commit 74720a72751c92bcb363d31c8a016e158771267e)
-rw-r--r--README72
-rw-r--r--distsrc/README88
2 files changed, 99 insertions, 61 deletions
diff --git a/README b/README
index c85c69e6cf2..162c59de45f 100644
--- a/README
+++ b/README
@@ -4,22 +4,26 @@ Welcome to MongoDB!
COMPONENTS
- mongod - The database process.
- mongos - Sharding controller.
+ mongod - The database server.
+ mongos - Sharding router.
mongo - The database shell (uses interactive javascript).
UTILITIES
- mongodump - MongoDB dump tool - for backups, snapshots, etc.
- mongorestore - MongoDB restore a dump
- mongoexport - Export a single collection to test (JSON, CSV)
- mongoimport - Import from JSON or CSV
- mongofiles - Utility for putting and getting files from MongoDB GridFS
- mongostat - Show performance statistics
+ mongodump - Create a binary dump of the contents of a database.
+ mongorestore - Restore data from the output created by mongodump.
+ mongoexport - Export the contents of a collection to JSON or CSV.
+ mongoimport - Import data from JSON, CSV or TSV.
+ mongofiles - Put, get and delete files from GridFS.
+ mongostat - Show the status of a running mongod/mongos.
+ bsondump - Convert BSON files into human-readable formats.
+ mongooplog - Poll the oplog and apply to a local server.
+ mongoreplay - Traffic capture and replay tool.
+ mongotop - Track time spent reading and writing data.
BUILDING
- See docs/building.md, also www.mongodb.org search for "Building".
+ See docs/building.md.
RUNNING
@@ -29,17 +33,22 @@ RUNNING
To run a single server database:
- $ mkdir /data/db
+ $ sudo mkdir -p /data/db
$ ./mongod
$
$ # The mongo javascript shell connects to localhost and test database by default:
- $ ./mongo
+ $ ./mongo
> help
DRIVERS
- Client drivers for most programming languages are available at mongodb.org. Use the
- shell ("mongo") for administrative tasks.
+ 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
@@ -48,32 +57,29 @@ PACKAGING
DOCUMENTATION
- http://www.mongodb.org/
-
-CLOUD MANAGED MONGODB
+ https://docs.mongodb.com/manual/
- http://mms.mongodb.com/
+=======
+CLOUD HOSTED MONGODB
-MAIL LISTS AND IRC
+ https://www.mongodb.com/cloud/atlas
- http://dochub.mongodb.org/core/community
-
-LEARN MONGODB
+MAIL LISTS
- http://university.mongodb.com/
+ https://groups.google.com/forum/#!forum/mongodb-user
-32 BIT BUILD NOTES
+ A forum for technical questions about using MongoDB.
- MongoDB uses memory mapped files. If built as a 32 bit executable, you will
- not be able to work with large (multi-gigabyte) databases. However, 32 bit
- builds work fine with small development databases.
+ https://groups.google.com/forum/#!forum/mongodb-dev
-LICENSE
+ A forum for technical questions about building and developing MongoDB.
- Most MongoDB source files (src/mongo folder and below) are made available under the terms of the
- GNU Affero General Public License (AGPL). See individual files for
- details.
+LEARN MONGODB
+
+ https://university.mongodb.com/
+
+LICENSE
- As an exception, the files in the client/, debian/, rpm/,
- utils/mongoutils, and all subdirectories thereof are made available under
- the terms of the Apache License, version 2.0.
+ Most MongoDB source files (src/mongo folder and below) are made available
+ under the terms of the GNU Affero General Public License (GNU AGPLv3). See
+ individual files for details.
diff --git a/distsrc/README b/distsrc/README
index 8cc83742981..ab71a40b425 100644
--- a/distsrc/README
+++ b/distsrc/README
@@ -1,22 +1,30 @@
MongoDB README
-Welcome to MongoDB!
-
+Welcome to MongoDB!
+
COMPONENTS
- bin/mongod - The database process.
- bin/mongos - Sharding controller.
- bin/mongo - The database shell (uses interactive javascript).
-
-UTILITIES
-
- bin/mongodump - MongoDB dump tool - for backups, snapshots, etc..
- bin/mongorestore - MongoDB restore a dump
- bin/mongoexport - Export a single collection to test (JSON, CSV)
- bin/mongoimport - Import from JSON or CSV
- bin/mongofiles - Utility for putting and getting files from MongoDB GridFS
- bin/mongostat - Show performance statistics
-
+ mongod - The database server.
+ mongos - Sharding router.
+ mongo - The database shell (uses interactive javascript).
+
+UTILITIES
+
+ mongodump - Create a binary dump of the contents of a database.
+ mongorestore - Restore data from the output created by mongodump.
+ mongoexport - Export the contents of a collection to JSON or CSV.
+ mongoimport - Import data from JSON, CSV or TSV.
+ mongofiles - Put, get and delete files from GridFS.
+ mongostat - Show the status of a running mongod/mongos.
+ bsondump - Convert BSON files into human-readable formats.
+ mongooplog - Poll the oplog and apply to a local server.
+ mongoreplay - Traffic capture and replay tool.
+ mongotop - Track time spent reading and writing data.
+
+BUILDING
+
+ See docs/building.md.
+
RUNNING
For command line options invoke:
@@ -25,28 +33,52 @@ RUNNING
To run a single server database:
- $ mkdir /data/db
+ $ sudo mkdir -p /data/db
$ ./mongod
$
$ # The mongo javascript shell connects to localhost and test database by default:
- $ ./mongo
+ $ ./mongo
> help
DRIVERS
- Client drivers for most programming languages are available at mongodb.org. Use the
- shell ("mongo") for administrative tasks.
+ 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 package.py script located in the
+ buildscripts directory. This will generate RPM and Debian packages.
DOCUMENTATION
- http://www.mongodb.org/
-
-MAIL LISTS AND IRC
-
- http://dochub.mongodb.org/core/community
+ https://docs.mongodb.com/manual/
+
+CLOUD HOSTED MONGODB
+
+ https://www.mongodb.com/cloud/atlas
+
+MAIL LISTS
+
+ https://groups.google.com/forum/#!forum/mongodb-user
+
+ A forum for technical questions about using MongoDB.
+
+ https://groups.google.com/forum/#!forum/mongodb-dev
+
+ A forum for technical questions about building and developing MongoDB.
+
+LEARN MONGODB
+
+ https://university.mongodb.com/
-32 BIT BUILD NOTES
+LICENSE
- MongoDB uses memory mapped files. If built as a 32 bit executable, you will
- not be able to work with large (multi-gigabyte) databases. However, 32 bit
- builds work fine with small development databases.
+ Most MongoDB source files (src/mongo folder and below) are made available
+ under the terms of the GNU Affero General Public License (GNU AGPLv3). See
+ individual files for details.