Verified Commit 725a8294 authored by MrMan's avatar MrMan
Browse files

HOTFIX: Fix incorrect documentation

- sqlite settings in s3/minio section
- add missing file structure preview
parent 7b01da46
......@@ -47,12 +47,20 @@ $ export RBB_SQLITE_BASE_DIR=/path/to/backup/area # this tells rbb where to plac
$ rbb --store-type sqlite-v1 backup --name test --uri redis://localhost:6379
```
If you used `/tmp/test` as your backup area and a backup name of `"test-backup"` you should see a file tree like the following:
```shell
$ tree /tmp/test
/tmp/test/
└── test-backup.sqlite
0 directories, 1 file
```
## S3/Minio ##
To use the `s3-v1` store type to perform a backup, run the following command:
```shell
$ export RBB_SQLITE_BASE_DIR=/path/to/backup/area # this tells rbb where to place the created DB file
$ export RBB_S3_ENDPOINT=http://127.0.0.1:9000
$ export RBB_S3_REGION=us-east-1
$ export RBB_S3_BUCKET=test-bucket
......@@ -61,9 +69,11 @@ $ export RBB_S3_SECRET_ACCESS_KEY=****************
$ rbb --store-type s3-v1 backup --name test --uri redis://localhost:6379
```
**NOTE** The S3 bucket you specify must exist *before* the backup is attempted. The bucket will hold multiple backups, you are not required to make a bucket per backup.
**NOTE** `REGION` is not required if using a Minio instance, but `ENDPOINT` is always required. AWS has a list of the [endpoints to use for AWS](https://docs.aws.amazon.com/general/latest/gr/s3.html)
**NOTE** The S3 bucket you specify must exist *before* the backup is attempted. The bucket will hold multiple backups, you are not required to make a bucket per backup.
Since the S3/Minio integration is remote, check the bucket to confirm the backup has been made -- the layout is similar (but slightly different) to the `folder` storage method.
## Performing a Restore ##
......@@ -82,9 +92,12 @@ To specify the URI of the server manually, use the `--uri` option to the `restor
You can perform restores with different storage backends by using the `--store-type` command line option. Of course, this only makes sense if you performed a back up with the same store to begin with. For example to use the `sqlite-v1` store type to perform a restore, run the following command:
```shell
RBB_SQLITE_BASE_DIR=/path/to/backup/area rbb --store-type sqlite-v1 restore --name test --uri redis://localhost:6379
$ export RBB_SQLITE_BASE_DIR=/path/to/backup/area
$ rbb --store-type sqlite-v1 restore --name test --uri redis://localhost:6379
```
**NOTE** Don't forget to set the all environment variables required by the storage method you used.
# Usage #
You can run `rbb --help` to read about the options the
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment