Skip to content

Commit 0ca42c9

Browse files
Doc updates, config file #9
1 parent 7ad420d commit 0ca42c9

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,28 @@ MongoDB Consistent Backup Tool - mongodb-consistent-backup
44
About
55
~~~~~
66

7-
Creates cluster-consistent point-in-time backups of MongoDB via wrapping
8-
'mongodump'. Backups are remotely-pulled and outputted onto the host
9-
running the tool.
7+
Creates cluster-consistent point-in-time backups of MongoDB with optional
8+
archiving, compression/de-duplication, encryption and upload functionality
109

1110
Features
1211
~~~~~~~~
1312

1413
- Works on a single replset (2+ members) or a sharded cluster
1514
- Auto-discovers healthy members for backup by considering replication
16-
lag, replication 'priority' and by preferring 'hidden' members.
15+
lag, replication 'priority' and by preferring 'hidden' members
1716
- Creates cluster-consistent backups across many separate shards
17+
- 'mongodump' is the default *(and currently only)* backup method. Other methods coming soon!
1818
- Transparent restore process (*just add --oplogReplay flag to your
1919
mongorestore command*)
2020
- Archiving and compression of backups (*optional*)
2121
- Block de-duplication and optional AES encryption at rest via `ZBackup <http://zbackup.org/>`__
2222
archiving method (*optional*)
23-
- AWS S3 Secure/HTTPS Multipart backup uploads (*optional*)
23+
- `AWS S3 <https://aws.amazon.com/s3/>`__ Secure Multipart backup uploads (*optional*)
2424
- `Nagios NSCA <https://sourceforge.net/p/nagios/nsca>`__ push
2525
notification support (*optional*)
2626
- Modular backup, archiving, upload and notification components
2727
- Multi-threaded, single executable
28+
- Auto-scales to number of available CPUs by default
2829

2930
Current Limitations
3031
~~~~~~~~~~~~~~~~~~~
@@ -162,7 +163,7 @@ ZBackup Archiving (Optional)
162163

163164
*Note: the ZBackup archive method is not yet compatible with the 'Upload' phase. Disable uploading by setting 'upload.method' to 'none' in the meantime.*
164165

165-
`ZBackup <http://zbackup.org/>`__ *(with LZMA compression)* is an optional archive method for mongodb_consistent_backup. This archive method significantly reduces disk usage for backups via deduplication and compression.
166+
`ZBackup <http://zbackup.org/>`__ *(with LZMA compression)* is an optional archive method for mongodb_consistent_backup. This archive method significantly reduces disk usage for backups via de-duplication and compression.
166167

167168
ZBackup offers block de-duplication and compression of backups and optionally supports AES-128 encryption at rest. The ZBackup archive method causes backups to be stored via ZBackup at archive time.
168169

0 commit comments

Comments
 (0)