Skip to content

Commit ebf0406

Browse files
Doc updates, config file #5
1 parent 6ecd2e4 commit ebf0406

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.rst

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,23 +47,35 @@ Requirements:
4747
compression, parallelism, etc
4848
- Must have Python 2.7 installed
4949

50+
Releases
51+
~~~~~~~~
52+
53+
Prebuilt release binaries and packages are available on our `GitHub Releases Page <releases>`__. We recommend most users deploy mongodb_consistent_backup using these packages.
54+
5055
Build/Install
5156
~~~~~~~~~~~~~
5257

53-
To build on CentOS/RedHat, you wil need the following packages (see
58+
To build on CentOS/RedHat, you will need the following packages (see
5459
command):
5560

5661
::
5762

58-
yum install python python-devel python-virtualenv gcc git make libffi-devel openssl-devel
63+
$ yum install python python-devel python-virtualenv gcc git make libffi-devel openssl-devel
5964

60-
To install to default '*/usr/local/bin/mongodb-consistent-backup*\ ':
65+
To build an CentOS/RedHat RPM of the tool *(recommended)*:
6166

6267
::
6368

64-
cd path/to/mongo_backup
65-
make
66-
make install
69+
$ cd /path/to/mongodb_consistent_backup
70+
$ make rpm
71+
72+
To install from source to default '*/usr/local/bin/mongodb-consistent-backup*\ ':
73+
74+
::
75+
76+
$ cd /path/to/mongodb_consistent_backup
77+
$ make
78+
$ make install
6779

6880
Use the PREFIX= variable to change the installation path (*default:
6981
/usr/local*), ie: ``make PREFIX=/usr install`` to install to:
@@ -98,7 +110,7 @@ Run a Backup
98110

99111
::
100112

101-
$ mongodb-consistent-backup -H mongos1.example.com -P 27018 -u mongodb-consistent-backup -p s3cr3t -n prodwebsite -l /opt/mongobackups
113+
$ mongodb-consistent-backup -H mongos1.example.com -P 27018 -u mongodb-consistent-backup -p s3cr3t -n prodwebsite -l /var/lib/mongodb-consistent-backup
102114
...
103115
...
104116
$ ls /opt/mongobackups
@@ -122,13 +134,13 @@ A description of all available config settings can also be listed by passing the
122134
Restore a Backup
123135
~~~~~~~~~~~~~~~~
124136

125-
The backups are mongorestore compatible. The *--oplogReplay* flag **MUST** be present to replay the oplogs to ensure consistency.
137+
The backups are mongorestore compatible and stored in a directory per backup. The *--oplogReplay* flag **MUST** be present to replay the oplogs to ensure consistency.
126138

127139
::
128140

129141
$ tar xfvz <shardname>.tar.gz
130142
...
131-
$ mongorestore --host mongod12.example.com --port 27017 -u admin -p 123456 --oplogReplay --dir /path/to/backup/dump
143+
$ mongorestore --host mongod12.example.com --port 27017 -u admin -p 123456 --oplogReplay --dir /var/lib/mongodb-consistent-backup/default/20170424_0000/rs0/dump
132144

133145
Run as Docker Container (Experimental)
134146
~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)