1
0
Fork 0
mirror of https://github.com/borgbase/vorta synced 2024-12-23 08:17:08 +00:00
vorta/README.md

2.8 KiB

Vorta - A Boring GUI for BorgBackup

Vorta is an open source macOS/Linux GUI for BorgBackup. It's currently in alpha status.

Main features

  • Encrypted, deduplicated and compressed backups.
  • Works with any remote SSH account that has borg installed. Or try BorgBase 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. Only allow on certain Wifis.
  • View a list of snapshots and action logs
  • Exclude options/patterns.

Coming soon:

  • Support multiple backup profiles (in progress)
  • Repo pruning
  • Repo checking
  • Full test coverage (currently: 65%)
  • Use static type checks via mypy?
  • Packaging for Linux? How?

Installation and Download

macOS

Download the pre-built binary from Releases. Just download, unzip and run.

Linux

No package yet. First install Borg's own dependencies. Then install via

$ pip install vorta

After installation run with the vorta command.

$ vorta

Development

Install in development mode:

$ pip install -e .

Then run via

$ vorta

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 binary package:

$ pyinstaller --clean --noconfirm vorta.spec 

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

To update and view coverage information

$ coverage run -m pytest
$ coverage report

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.

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.

Author

(C) 2018 Manuel Riel for BorgBase.com

License and Credits