From 423238bc075f1da856ac21258b063859994965f1 Mon Sep 17 00:00:00 2001 From: netbenix Date: Fri, 31 Dec 2021 17:29:12 +0100 Subject: [PATCH] docs(README): Updated config explanation --- README.md | 45 +++++++++++++++++++++++++++------------------ 1 file changed, 27 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 794faa2..9bacc73 100644 --- a/README.md +++ b/README.md @@ -42,21 +42,30 @@ Trello board: [Click me!](https://trello.com/b/6zWLE6Jm) ## Config Explaination ### config.json -| Field | Type | Description | -|---------------------------|:----------------:|------------------------------------------------| -| localBackupPath | string | Path where local backups are stored | -| **sqlConfig** | ---------------- | ---------------------------------------------- | -| enableSQL | boolean | Enable/Disables the SQL entries -| sqlType | string | See [DatabaseTypes](#database-types) | -| sql-address | string | Address to the SQL Server | -| sql-port | uint16 | SQL Server Port | -| database | string | Database name | -| db-user | string | SQL username from user which should be used | -| db-password | string | SQL password from user which should be used | -| **foldersToBackup** | ---------------- | ---------------------------------------------- | -| backupName | string | .bak file name | -| folderPath | string | Path to folder which should be backed up | -| remoteStorageType | string | See [StorageTypes](#storage-types) | -| remoteTargetPath | string | Sets the remotePath for remote backups | -| localTargetPath | string | Sets the targetPath for local backups | -| createLocalBackup | boolean | Sets if .bak file should also be saved locally | \ No newline at end of file +| Field | Type | Description | +|-----------------------|:----------------:|------------------------------------------------| +| **foldersToBackup** | ---------------- | ---------------------------------------------- | +| backupName | string | .bak file name | +| folderPath | string | Path to folder which should be backed up | +| remoteStorageType | string | See [StorageTypes](#storage-types) | +| remoteTargetPath | string | Sets the remotePath for remote backups | +| localTargetPath | string | Sets the targetPath for local backups | +| createLocalBackup | boolean | Sets if .bak file should also be saved locally | + +### sql-config.json +| Field | Type | Description | +|--------------|:----------------:|------------------------------------------------| +| enableSQL | boolean | Enable/Disables the SQL entries | +| sqlType | string | See [DatabaseTypes](#database-types) | +| sql-address | string | Address to the SQL Server | +| sql-port | uint16 | SQL Server Port | +| database | string | Database name | +| db-user | string | SQL username from user which should be used | +| db-password | string | SQL password from user which should be used | + +### azure.json +| Field | Type | Description | +|--------------------|:------:|-----------------------------------| +| fileshareName | string | The name of the Azure File Share | +| storageAccountName | string | Name of your storage account | +| storageAccountKey | string | Key for the storage account |