From badc3955d704deea3b208c9fd611fc28b59ae3a0 Mon Sep 17 00:00:00 2001 From: netbenix Date: Fri, 19 Nov 2021 19:49:38 +0100 Subject: [PATCH] Updated README --- README.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e6bbe14..86ec1f9 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,13 @@ Please keep in mind that this project is WIP. ## What can it do? -- Backup you stuff via a dynamic configuration -- Log the Backup progress to a database +- Backup you stuff via a dynamic configuration (done!) +- Log the Backup progress to a database (planned) +- Upload the files to a remote storage of your choice (see [Storage Types](#storage-types)) ## Database Types -- MariaDB (planned) +- MariaDB (soon) - MySQL (far future) - MS-SQL (far future) @@ -16,8 +17,32 @@ Please keep in mind that this project is WIP. ## Storage types - Local storage (soon) - Azure Blob Storage (planned) -- Azure File Share (planned) +- Azure File Share (done!) - S3 Bucket (far future) - Dropbox (far future) - OneDrive (far future) - GDrive (far future) + +| Storage Type | Config Type | +|-------------------------|--------------------------| +| Azure File Share | azure-fileshare | + + +## Config Explaination + +### config.json +| Field | Type | Description | +|---------------------|:----------------:|------------------------------------------------| +| localBackupPath | string | Path where local backups are stored | +| **sqlConfig** | ---------------- | ---------------------------------------------- | +| sqlType | string | SQL Server Type (not yet used) | +| 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 | +| storageType | string | See [StorageTypes](#storage-types) | +| createLocalBackup | boolean | Sets if .bak file should also be saved locally | \ No newline at end of file