vorta/README.md

46 lines
1.3 KiB
Markdown
Raw Normal View History

2018-10-26 11:24:13 +00:00
# Vorta - BorgBackup GUI
2018-10-26 16:01:59 +00:00
[Vorta](http://memory-alpha.wikia.com/wiki/Vorta) is a GUI for [BorgBackup](https://borgbackup.readthedocs.io). It's in alpha status and currently has the following features:
2018-10-26 11:24:13 +00:00
- Select and manage SSH keys
- Initialize new remote Borg repositories
- Create new Borg snapshots (backups) from local folders
- Display existing snapshots and repository details.
2018-10-26 16:01:59 +00:00
- Settings stored in sqlite
- Borg binary integrated
2018-10-26 11:24:13 +00:00
Planned features:
- Scheduling for background backups.
- Rule-based scheduling by time, Wifi SSID, etc.
- Repo pruning
- Repo checking
- Securely save repo password in Keychain instead of database.
- Handle encrypted SSH keys
- Check for duplicate source dirs
## Development
2018-10-26 16:01:59 +00:00
Conda is used for dependency management. Create a new virtual env using:
```
$ conda env create environment.yml
```
2018-10-26 11:24:13 +00:00
2018-10-26 16:01:59 +00:00
Qt Creator is used to edit views. Install using Homebrew and then open the .ui files in `vorta/UI`:
```
$ brew cask install qt-creater
$ brew install qt
```
To build a binary package:
```
$ pyinstaller --clean --noconfirm vorta.spec
```
## Author
(C) 2018 Manuel Riel for [BorgBase.com](https://www.borgbase.com)
## License and Credits
- Licensed under GPLv3. See LICENSE.txt for details.
- Uses the excellent [BorgBackup](https://www.borgbackup.org)
- Based on PyQt and Qt.