diff --git a/README.md b/README.md index 9f64c57..c6255e7 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,11 @@ Trello board: [Click me!](https://trello.com/b/6zWLE6Jm) - Log the Backup progress to a database - Upload the files to a remote storage of your choice (see [Storage Types](#storage-types)) +## Planned features for the Future! +- Backup restore +- DB Upgrade +- Service for scheduled updates +- (Maybe) a web interface ## Database Types - MariaDB @@ -21,9 +26,9 @@ Trello board: [Click me!](https://trello.com/b/6zWLE6Jm) ## Storage types -- Local storage (soon) -- Azure Blob Storage (planned) +- Local storage - Azure File Share +- Azure Blob Storage (planned) - S3 Bucket (far future) - Dropbox (far future) - OneDrive (far future) @@ -32,24 +37,26 @@ Trello board: [Click me!](https://trello.com/b/6zWLE6Jm) | Storage Type | Config Type | |-------------------------|--------------------------| | Azure File Share | azure-fileshare | +| Local Storage | none | ## 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 | -| storageType | string | See [StorageTypes](#storage-types) | -| createLocalBackup | boolean | Sets if .bak file should also be saved locally | \ No newline at end of file +| 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) | +| targetPath | string | Sets the targetPath for local backups | +| createLocalBackup | boolean | Sets if .bak file should also be saved locally | \ No newline at end of file