2018-10-28 17:33:14 +00:00
# Vorta - A Boring GUI for BorgBackup
2018-10-26 11:24:13 +00:00
2018-10-28 17:19:12 +00:00
2018-10-27 11:21:14 +00:00
2018-11-01 05:11:37 +00:00
Vorta is a macOS/Linux GUI for [BorgBackup ](https://borgbackup.readthedocs.io ). It's currently in alpha status.
2018-10-26 11:24:13 +00:00
2018-11-01 05:11:37 +00:00
## Main features
2018-10-26 11:24:13 +00:00
2018-11-01 05:11:37 +00:00
- Encrypted, deduplicated and compressed backups to remote repositories
- Works with any remote SSH account that has `borg` installed. Or try [BorgBase ](https://www.borgbase.com ) for advanced features like append-only repositories and monitoring.
- Add SSH keys and initialize repos directly from the GUI
- Repo keys are securely stored in macOS Keychain, Secret Service or KWallet
- Mount existing snapshots via FUSE
- Flexible scheduling for automatic background backups.
- View a list of snapshots and action logs
- Exclude options/patterns.
Missing features: (PRs welcome)
2018-10-26 11:24:13 +00:00
2018-10-28 15:40:38 +00:00
- [ ] Repo pruning
- [ ] Repo checking
2018-11-01 05:11:37 +00:00
- [ ] Full test coverage
2018-11-01 06:01:44 +00:00
- [ ] Use static type checks via mypy
2018-11-01 05:11:37 +00:00
- [ ] Packaging for Linux
2018-10-26 11:24:13 +00:00
2018-11-01 05:11:37 +00:00
## Installation and Download
### macOS
2018-10-27 12:04:55 +00:00
The app package under [Releases ](https://github.com/borgbase/vorta/releases ) should include everything. Just download, unzip and run.
2018-11-01 05:11:37 +00:00
### Linux
No package yet. First install Borg's own [dependencies ](https://borgbackup.readthedocs.io/en/stable/installation.html#dependencies ). Then install via
```
$ pip install vorta
```
After installation run with the `vorta` command.
```
$ vorta
```
2018-10-26 11:24:13 +00:00
## Development
2018-11-01 05:11:37 +00:00
Install in development mode:
2018-10-26 16:01:59 +00:00
```
2018-11-01 05:11:37 +00:00
$ pip install -e .
2018-10-26 16:01:59 +00:00
```
2018-10-26 11:24:13 +00:00
2018-11-01 05:11:37 +00:00
Then run via
2018-10-26 16:01:59 +00:00
```
2018-11-01 05:11:37 +00:00
$ vorta
2018-10-26 16:01:59 +00:00
```
2018-11-01 06:01:44 +00:00
Qt Creator is used to edit views. Install from [their site ](https://www.qt.io/download ) or using Homebrew and then open the .ui files in `vorta/UI` :
2018-10-31 11:14:12 +00:00
```
2018-11-01 05:11:37 +00:00
$ brew cask install qt-creator
$ brew install qt
2018-10-31 11:14:12 +00:00
```
2018-10-26 16:01:59 +00:00
To build a binary package:
```
$ pyinstaller --clean --noconfirm vorta.spec
```
2018-10-30 17:46:37 +00:00
### Testing (work in progress)
2018-11-01 05:11:37 +00:00
Tests are in the folder `/tests` . Testing happens at the level of UI components. Calls to `borg` are mocked and can be replaced with some example json-output. To run tests:
```
2018-11-01 06:01:44 +00:00
$ pytest
2018-11-01 05:11:37 +00:00
```
2018-10-30 17:46:37 +00:00
2018-11-01 05:11:37 +00:00
## Privacy Policy
- No personal data is ever stored or transmitted by this application.
- During beta, crash reports are sent to [Sentry ](https://sentry.io ) to quickly find bugs.
2018-10-30 17:46:37 +00:00
2018-10-27 10:12:30 +00:00
## Why the Name?
[Vorta ](http://memory-alpha.wikia.com/wiki/Vorta ) are a race referenced in Star Trek. They serve the Dominion and are replaced by their clones if they die. Just like our backups.
2018-10-26 16:01:59 +00:00
## 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 )
2018-11-01 06:01:44 +00:00
- Based on [PyQt ](https://riverbankcomputing.com/software/pyqt/intro ) and [Qt ](https://www.qt.io ).
2018-10-27 17:40:08 +00:00
- Icons by [FontAwesome ](https://fontawesome.com )
