62 lines
No EOL
2.7 KiB
Markdown
62 lines
No EOL
2.7 KiB
Markdown
# Scabiosa Backup Tool
|
|
|
|
Please keep in mind that this project is WIP.
|
|
|
|
Trello board: [Click me!](https://trello.com/b/6zWLE6Jm)
|
|
|
|
## What can it do?
|
|
- Backup you stuff via a dynamic configuration
|
|
- 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
|
|
- MySQL (soon)
|
|
- MS-SQL (far future)
|
|
|
|
| Database Type | Config Type |
|
|
|-------------------|---------------------------|
|
|
| MariaDB | mariadb |
|
|
|
|
|
|
## Storage types
|
|
- Local storage
|
|
- Azure File Share
|
|
- Azure Blob Storage (planned)
|
|
- S3 Bucket (far future)
|
|
- Dropbox (far future)
|
|
- OneDrive (far future)
|
|
- GDrive (far future)
|
|
|
|
| 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 |
|
|
| 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 | |