Skip to content

Commit 8616704

Browse files
Doc updates, config file #3
1 parent 79aa232 commit 8616704

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ Run a Backup
9494

9595
**Using Command-Line Flags**
9696

97+
*Note: username+password is visible in process lists when set using the command-line flags. Use a config file (below) to hide credentials!*
98+
9799
::
98100

99101
$ mongodb-consistent-backup -H mongos1.example.com -P 27018 -u mongodb-consistent-backup -p s3cr3t -n prodwebsite -l /opt/mongobackups
@@ -149,11 +151,15 @@ Run as Docker Container (Experimental)
149151
ZBackup Archiving (Optional)
150152
~~~~~~~
151153

154+
*Note: the ZBackup archive method is not yet compatible with the 'Upload' phase. Disable uploading by setting 'upload.method' to 'none' in the meantime.*
155+
152156
`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.
153157

154158
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.
155159

156-
To enable, ZBackup must be installed on your system and the 'archive.method' config file variable *(or --archive.method flag=)* must be set to 'zbackup'. ZBackup's compression works best if compression is disabled in the backup phase, to do this set 'backup.<method>.compression' to 'none'.
160+
To enable, ZBackup must be installed on your system and the 'archive.method' config file variable *(or --archive.method flag=)* must be set to 'zbackup'.
161+
162+
ZBackup's compression is most efficient when compression is disabled in the backup phase, to do this set 'backup.<method>.compression' to 'none'.
157163

158164
**Install on CentOS/RHEL**
159165

@@ -178,7 +184,7 @@ ZBackup data is stored in a storage directory named *'mongodb_consistent_backup-
178184

179185
**Delete Backup from ZBackup**
180186

181-
To remove a backup, first delete the .tar file in 'backups' subdir of the ZBackup storage directory. After run a 'zbackup gc full' to remove unused data.
187+
To remove a backup, first delete the .tar file in 'backups' subdir of the ZBackup storage directory. After, run a 'zbackup gc full' garbage collection to remove unused data.
182188

183189
::
184190

@@ -189,6 +195,7 @@ Roadmap
189195
~~~~~~~
190196

191197
- "Distributed Mode" for running backup on remote hosts *(vs. only on one host)*
198+
- Upload compatibility for ZBackup archive phase *(upload unsupported today)*
192199
- Backup retention/rotation *(eg: delete old backups)*
193200
- Support more notification methods *(Prometheus, PagerDuty, etc)*
194201
- Support more upload methods *(Google Cloud Storage, Rsync, etc)*

0 commit comments

Comments
 (0)