Skip to content

Commit 7ad420d

Browse files
Doc updates, config file #8
1 parent 18fc94b commit 7ad420d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Requirements:
3838
~~~~~~~~~~~~~
3939

4040
- Backup consistency depends on consistent server time across all
41-
hosts. Server time **must be synchronized on all nodes** using ntpd
41+
hosts! Server time **must be synchronized on all nodes** using ntpd
4242
and a consistent time source or virtualization guest agent that
4343
syncs time
4444
- Must have 'mongodump' installed and specified if not at default:
@@ -81,13 +81,13 @@ Use the PREFIX= variable to change the installation path (*default: /usr/local*)
8181
MongoDB Authorization
8282
~~~~~~~~~~~~~~~~~~~~~
8383

84-
If your replset/cluster uses `Authentication <https://docs.mongodb.com/manual/core/authentication>`__, you must add a user with the "backup" and "clusterMonitor" built-in auth roles.
84+
If your replset/cluster uses `Authentication <https://docs.mongodb.com/manual/core/authentication>`__, you must add a user with the `"backup" <https://docs.mongodb.com/manual/reference/built-in-roles/#backup>`__ and `"clusterMonitor" <https://docs.mongodb.com/manual/reference/built-in-roles/#clusterMonitor>`__ built-in auth roles.
8585

8686
To create a user, execute the following **replace the 'pwd' field with a secure password!**:
8787

8888
::
8989

90-
db.createUser({
90+
db.getSiblingDB("admin").createUser({
9191
user: "mongodb_consistent_backup",
9292
pwd: "PASSWORD-HERE",
9393
roles: [
@@ -203,12 +203,14 @@ To remove a backup, first delete the .tar file in 'backups' subdir of the ZBacku
203203
Roadmap
204204
~~~~~~~
205205

206+
- More testing: this project has many flows that probably need more in-depth testing. Please submit and bugs and/or bugfixes!
206207
- "Distributed Mode" for running backup on remote hosts *(vs. only on one host)*
207208
- Upload compatibility for ZBackup archive phase *(upload unsupported today)*
208209
- Backup retention/rotation *(eg: delete old backups)*
209210
- Support more notification methods *(Prometheus, PagerDuty, etc)*
210211
- Support more upload methods *(Google Cloud Storage, Rsync, etc)*
211212
- Support SSL MongoDB connections
213+
- Documentation for running under Docker with persistent volumes
212214
- Python unit tests
213215

214216
Contact

0 commit comments

Comments
 (0)