liliesh/scabiosa
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Updated README

Browse source
This commit is contained in:
netbenix 2021-11-19 19:49:38 +01:00
parent d7f7377e1e
commit badc3955d7
1 changed files with 29 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -3,12 +3,13 @@
Please keep in mind that this project is WIP. Please keep in mind that this project is WIP.
## What can it do? ## What can it do?
- Backup you stuff via a dynamic configuration - Backup you stuff via a dynamic configuration (done!)
- Log the Backup progress to a database - 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 ## Database Types
- MariaDB (planned) - MariaDB (soon)
- MySQL (far future) - MySQL (far future)
- MS-SQL (far future) - MS-SQL (far future)
@ -16,8 +17,32 @@ Please keep in mind that this project is WIP.
## Storage types ## Storage types
- Local storage (soon) - Local storage (soon)
- Azure Blob Storage (planned) - Azure Blob Storage (planned)
- Azure File Share (planned) - Azure File Share (done!)
- S3 Bucket (far future) - S3 Bucket (far future)
- Dropbox (far future) - Dropbox (far future)
- OneDrive (far future) - OneDrive (far future)
- GDrive (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 |