vorta/README.md

# Vorta Backup Client <img alt="Logo" src="https://files.qmax.us/vorta/vorta-512px.png" align="right" height="50">

[![GitHub all releases](https://img.shields.io/github/downloads/borgbase/vorta/total?label=downloads&logo=github&color=green)](https://github.com/borgbase/vorta/releases)
[![Flathub](https://img.shields.io/flathub/downloads/com.borgbase.Vorta?logo=flathub&logoColor=white&color=green)](https://flathub.org/apps/details/com.borgbase.Vorta)
[![Github License](https://img.shields.io/github/license/borgbase/vorta?color=bd0000)](https://github.com/borgbase/vorta/blob/master/LICENSE.txt)
[![pypi](https://img.shields.io/pypi/v/vorta.svg?logo=pypi&logoColor=white&color=0073b7)](https://pypi.org/project/vorta/)
[![homebrew cask](https://img.shields.io/homebrew/cask/v/vorta?logo=homebrew&color=fbb040)](https://formulae.brew.sh/cask/vorta)
[![Flathub](https://img.shields.io/flathub/v/com.borgbase.Vorta?color=4a86cf&logo=flathub&logoColor=white)](https://flathub.org/apps/details/com.borgbase.Vorta)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://pre-commit.com)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
<br>
<br>

Vorta is a backup client for macOS and Linux desktops. It integrates the mighty [BorgBackup](https://borgbackup.readthedocs.io) with your desktop environment to protect your data from disk failure, ransomware and theft.

https://github.com/m3nu/vorta/assets/3916435/a622a148-5373-4ae0-87bc-4ca1d6f6202e

## Why is this great? 🤩

- **Encrypted, deduplicated and compressed backups** using [Borg](https://borgbackup.readthedocs.io) as backend.
- **No vendor lock-in** – back up to local drives, your own server or [BorgBase](https://www.borgbase.com), a hosting service for Borg backups.
- **Open source** – free to use, modify, improve and audit.
- **Flexible profiles** to group source folders, backup destinations and schedules.
- **One place** to view all point-in-time archives and restore individual files.

Learn more on [Vorta's website](https://vorta.borgbase.com).

## Installation
Vorta should work on all platforms that support Qt and Borg. This includes macOS, Ubuntu, Debian, Fedora, Arch Linux and many others. Windows is currently not supported by Borg, but this may change in the future.

See our website for [download links and install instructions](https://vorta.borgbase.com/install).

## Connect and Contribute
- To discuss everything around using, improving, packaging and translating Vorta, join the [discussion on Github](https://github.com/borgbase/vorta/discussions).
- Report bugs by opening a new [Github issue](https://github.com/borgbase/vorta/issues/new/choose).
- Want to contribute to Vorta? Great! See our [contributor guide](https://vorta.borgbase.com/contributing/) on how to help out with coding, translation and packaging.
- We currently have students from the Google Summer Of Code 2023 Program contributing to this project.

## License and Credits
- See [CONTRIBUTORS.md](CONTRIBUTORS.md) to see who programmed and translated Vorta.
- Licensed under [GPLv3](LICENSE.txt). © 2018-2023 Manuel Riel and Vorta contributors
- Based on [PyQt](https://riverbankcomputing.com/software/pyqt/intro) and [Qt](https://www.qt.io).
- Icons by [Fork Awesome](https://forkaweso.me/) (licensed under [SIL Open Font License](https://scripts.sil.org/OFL), Version 1.1) and Material Design icons by Google (licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)). See the `src/vorta/assets/icons` folder for a copy of applicable licenses.
-												V0.6.2 – Restructure README (#97)

* Dont open main window on startup unless --foreground is given. Fixes #91
* Clean up README. #93
* Make sentry reporting a setting.

											
										
										
											2018-12-18 11:23:34 +00:00
+								# Vorta Backup Client <img alt="Logo" src="https://files.qmax.us/vorta/vorta-512px.png" align="right" height="50">
-												Basic working version.

											
										
										
											2018-10-26 11:24:13 +00:00
-												Add badges to `README.md`. (#1406)


											
										
										
											2022-08-25 14:04:38 +00:00
+								[![GitHub all releases](https://img.shields.io/github/downloads/borgbase/vorta/total?label=downloads&logo=github&color=green)](https://github.com/borgbase/vorta/releases)
 								[![Flathub](https://img.shields.io/flathub/downloads/com.borgbase.Vorta?logo=flathub&logoColor=white&color=green)](https://flathub.org/apps/details/com.borgbase.Vorta)
 								[![Github License](https://img.shields.io/github/license/borgbase/vorta?color=bd0000)](https://github.com/borgbase/vorta/blob/master/LICENSE.txt)
 								[![pypi](https://img.shields.io/pypi/v/vorta.svg?logo=pypi&logoColor=white&color=0073b7)](https://pypi.org/project/vorta/)
 								[![homebrew cask](https://img.shields.io/homebrew/cask/v/vorta?logo=homebrew&color=fbb040)](https://formulae.brew.sh/cask/vorta)
 								[![Flathub](https://img.shields.io/flathub/v/com.borgbase.Vorta?color=4a86cf&logo=flathub&logoColor=white)](https://flathub.org/apps/details/com.borgbase.Vorta)
 								[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://pre-commit.com)
 								[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 								<br>
 								<br>
-												V0.6.2 – Restructure README (#97)

* Dont open main window on startup unless --foreground is given. Fixes #91
* Clean up README. #93
* Make sentry reporting a setting.

											
										
										
											2018-12-18 11:23:34 +00:00
+								Vorta is a backup client for macOS and Linux desktops. It integrates the mighty [BorgBackup](https://borgbackup.readthedocs.io) with your desktop environment to protect your data from disk failure, ransomware and theft.
-												Add version number.

											
										
										
											2018-10-27 12:04:55 +00:00
-												Update screencast for v0.9 (#1881)


											
										
										
											2024-01-10 13:11:38 +00:00
+								https://github.com/m3nu/vorta/assets/3916435/a622a148-5373-4ae0-87bc-4ca1d6f6202e
-												Basic working version.

											
										
										
											2018-10-26 11:24:13 +00:00
-												V0.6.2 – Restructure README (#97)

* Dont open main window on startup unless --foreground is given. Fixes #91
* Clean up README. #93
* Make sentry reporting a setting.

											
										
										
											2018-12-18 11:23:34 +00:00
+								## Why is this great? 🤩
-												Finish packaging.

											
										
										
											2018-10-26 16:01:59 +00:00
-												V0.6.2 – Restructure README (#97)

* Dont open main window on startup unless --foreground is given. Fixes #91
* Clean up README. #93
* Make sentry reporting a setting.

											
										
										
											2018-12-18 11:23:34 +00:00
+								- **Encrypted, deduplicated and compressed backups** using [Borg](https://borgbackup.readthedocs.io) as backend.
 								- **No vendor lock-in** – back up to local drives, your own server or [BorgBase](https://www.borgbase.com), a hosting service for Borg backups.
 								- **Open source** – free to use, modify, improve and audit.
 								- **Flexible profiles** to group source folders, backup destinations and schedules.
 								- **One place** to view all point-in-time archives and restore individual files.
-												Attempt to fix unresponsive parent process on macOS.

											
										
										
											2018-11-05 15:07:42 +00:00
-												Remove redundant docs from repo and link to new website. (#334)

* Remove redundant docs from repo and link to new website.
* Reduce Matrix advertising a bit.
* Remove first website link.

											
										
										
											2019-07-25 04:16:44 +00:00
+								Learn more on [Vorta's website](https://vorta.borgbase.com).
-												Subclass QApplication.

											
										
										
											2018-10-31 11:14:12 +00:00
-												V0.6.2 – Restructure README (#97)

* Dont open main window on startup unless --foreground is given. Fixes #91
* Clean up README. #93
* Make sentry reporting a setting.

											
										
										
											2018-12-18 11:23:34 +00:00
+								## Installation
 								Vorta should work on all platforms that support Qt and Borg. This includes macOS, Ubuntu, Debian, Fedora, Arch Linux and many others. Windows is currently not supported by Borg, but this may change in the future.
-												Finish packaging.

											
										
										
											2018-10-26 16:01:59 +00:00
-												Minor: README type. By @prady0t (#1822)


											
										
										
											2023-09-19 09:02:47 +00:00
+								See our website for [download links and install instructions](https://vorta.borgbase.com/install).
-												Working version with snapshots and ssh creation.

											
										
										
											2018-10-27 10:12:30 +00:00
-												Add link to new discussion area
											
										
										
											2021-02-15 15:44:32 +00:00
+								## Connect and Contribute
 								- To discuss everything around using, improving, packaging and translating Vorta, join the [discussion on Github](https://github.com/borgbase/vorta/discussions).
 								- Report bugs by opening a new [Github issue](https://github.com/borgbase/vorta/issues/new/choose).
-												Remove redundant docs from repo and link to new website. (#334)

* Remove redundant docs from repo and link to new website.
* Reduce Matrix advertising a bit.
* Remove first website link.

											
										
										
											2019-07-25 04:16:44 +00:00
+								- Want to contribute to Vorta? Great! See our [contributor guide](https://vorta.borgbase.com/contributing/) on how to help out with coding, translation and packaging.
-												Update GSoC notice in README (#1739)

* README.md
											
										
										
											2023-06-27 09:30:41 +00:00
+								- We currently have students from the Google Summer Of Code 2023 Program contributing to this project.
-												Adding options to get in touch (#325)



											
										
										
											2019-07-20 16:30:19 +00:00
-												Finish packaging.

											
										
										
											2018-10-26 16:01:59 +00:00
+								## License and Credits
-												Add CONTRIBUTORS file and copyright note. Fixes #403 (#404)

* Add CONTRIBUTORS file and copyright note. Fixes #403
* Add credits for Czech and Finnish translators.
* Minor Travis fix
											
										
										
											2020-02-27 12:54:44 +00:00
+								- See [CONTRIBUTORS.md](CONTRIBUTORS.md) to see who programmed and translated Vorta.
-												Replace Font Awesome icons with  Fork Awesome and others (#1729)


											
										
										
											2023-06-19 07:16:37 +00:00
+								- Licensed under [GPLv3](LICENSE.txt). © 2018-2023 Manuel Riel and Vorta contributors
-												Add test for scheduler tab.

											
										
										
											2018-11-01 06:01:44 +00:00
+								- Based on [PyQt](https://riverbankcomputing.com/software/pyqt/intro) and [Qt](https://www.qt.io).
-												Add full font licenses, add Google icons to README. (#1740)


											
										
										
											2023-08-13 18:53:12 +00:00
+								- Icons by [Fork Awesome](https://forkaweso.me/) (licensed under [SIL Open Font License](https://scripts.sil.org/OFL), Version 1.1) and Material Design icons by Google (licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)). See the `src/vorta/assets/icons` folder for a copy of applicable licenses.