docs(README): Added config examples
This commit is contained in:
parent
423238bc07
commit
e911e1cf45
1 changed files with 35 additions and 0 deletions
35
README.md
35
README.md
|
|
@ -69,3 +69,38 @@ Trello board: [Click me!](https://trello.com/b/6zWLE6Jm)
|
||||||
| fileshareName | string | The name of the Azure File Share |
|
| fileshareName | string | The name of the Azure File Share |
|
||||||
| storageAccountName | string | Name of your storage account |
|
| storageAccountName | string | Name of your storage account |
|
||||||
| storageAccountKey | string | Key for the storage account |
|
| storageAccountKey | string | Key for the storage account |
|
||||||
|
|
||||||
|
|
||||||
|
## Config Examples
|
||||||
|
|
||||||
|
### config.json (Linux)
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"foldersToBackup": [
|
||||||
|
{
|
||||||
|
"backupName": "my-backup",
|
||||||
|
"folderPath": "/path/to/folder/to/backup",
|
||||||
|
"remoteStorageType": "remote-type",
|
||||||
|
"remoteTargetPath": "path/to",
|
||||||
|
"createLocalBackup": true,
|
||||||
|
"localTargetPath": "/path/for/local/backup"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### config.json (Windows)
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"foldersToBackup": [
|
||||||
|
{
|
||||||
|
"backupName": "my-backup",
|
||||||
|
"folderPath": "D:\\Path\\To\\Folder\\To\\Backup",
|
||||||
|
"remoteStorageType": "remote-type",
|
||||||
|
"remoteTargetPath": "path/to",
|
||||||
|
"createLocalBackup": true,
|
||||||
|
"localTargetPath": "E:\\Path\\For\\Local Backup"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
Reference in a new issue