aa7f45244f | ||
---|---|---|
bin/macosx64 | ||
requirements.d | ||
src/vorta | ||
tests | ||
.bumpversion.cfg | ||
.gitignore | ||
.travis.yml | ||
LICENSE.txt | ||
MANIFEST.in | ||
Makefile | ||
README.md | ||
Vagrantfile | ||
appdmg.json | ||
setup.cfg | ||
setup.py | ||
vorta.spec |
README.md
Vorta - A Boring Open Source GUI for BorgBackup
Vorta is an open source macOS/Linux GUI for BorgBackup. It's currently in beta status.
Main features
- Encrypted, deduplicated and compressed backups using
borg
as battle-tested backend. - Works with any local or remote Borg repo. Try BorgBase for advanced features like append-only repositories and monitoring.
- Repo keys are securely stored in macOS Keychain, SecretService or KWallet. Create SSH keys directly from the GUI.
- Manage multiple backup profiles with different source folders, destinations and settings.
- Flexible scheduling for automatic background backups. Only allow on certain Wifis.
- Restore files from mounts or using the built-in backup browser.
Installation and Download
Vorta should work on all platforms that support Qt and Borg. Currently Borg doesn't support Windows, but this may change in the future. Setting allowed Wifi networks is currently not supported on Linux, but everything else should work.
macOS
Install the latest stable version via Homebrew Cask:
$ brew cask install vorta
Or directly download pre-built app bundles for macOS (10.13+) from Releases. For detailed setup steps, see the tutorial.
Linux
First install Borg using the package of your distribution or via PyPI. The latter needs some additional source packages. Then install Vorta from PyPI. Your local Python version should be >= 3.6. Python 2 is not supported.
$ pip3 install vorta
After installation run with the vorta
command.
$ vorta
Debugging and Bugs
Please report any errors you may encounter by opening an issue on Github. Please include steps to reproduce and all logging output. Logs can be found in these folders:
- Linux:
$HOME/.cache/Vorta/log
- macOS:
$HOME/Library/Logs/Vorta
Development
Install in development/editable mode while in the repo:
$ pip install -e .
Then run as Python script:
$ vorta
Install developer packages we use (pytest, tox, pyinstaller):
pip install -r requirements.d/dev.txt
Qt Creator is used to edit views. Install from their site or using Homebrew and then open the .ui files in vorta/UI
:
$ brew cask install qt-creator
$ brew install qt
To build a macOS app package:
- add
Sparkle.framework
from here andborg
from here inbin/macosx64
- then uncomment or change the Apple signing profile to be used in
Makefile
- finally run to
$ make Vorta.app
to build the app into thedist
folder.
Testing (work in progress)
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:
$ pytest
Why the Name?
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.
Privacy Policy
- No personal data is ever stored or transmitted by this application.
- During beta, crash reports are sent to Sentry to quickly find bugs. You can disable this by setting the env variable
NO_SENTRY=1
. Your repo password will be scrubbed before the test report is transmitted.
Author
(C) 2018 Manuel Riel for BorgBase.com
License and Credits
- Licensed under GPLv3. See LICENSE.txt for details.
- Uses the excellent BorgBackup
- Based on PyQt and Qt.
- Icons by FontAwesome