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

docs(README): Updated Readme

Browse source
This commit is contained in:
netbenix 2021-12-23 09:30:57 +01:00
parent 7e4c05f411
commit 813dcded54
1 changed files with 25 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -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 |
| 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 |