vorta/INSTALL.md

# Installing


## Install from Source
The generic way is to install it as Python package using [PIP](https://pip.readthedocs.io/en/stable/installing/). First [install](https://borgbackup.readthedocs.io/en/stable/installation.html) Borg using the package of your distribution or via PyPI. The latter needs some additional [source packages](https://borgbackup.readthedocs.io/en/stable/installation.html#dependencies). Then install Vorta from PyPI. Your local Python version should be >= 3.6.
```
$ pip3 install vorta
```

### Desktop Tray Icon
Unless Vorta is started with the `--foreground` option, it will minimize to the system tray without opening a settings window. Be sure your desktop environment supports tray icons by e.g. installing this [Gnome extension](https://extensions.gnome.org/extension/615/appindicator-support/).

## Distribution Packages
If available, prefer distribution-specific packages, as they offer better integration. (If you added Vorta to a Linux distribution, open an issue or PR and it will be added here.)

### Apple macOS
Install via [Homebrew Cask](https://brew.sh/) or download a pre-built app bundle for macOS (10.13+) from [Releases](https://github.com/borgbase/vorta/releases).
```
$ brew cask install vorta
```
### Arch Linux
Use the [AUR package](https://aur.archlinux.org/packages/vorta/) maintained by [@bjo81](https://github.com/bjo81).
```
$ yaourt -S vorta
```
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			`# Installing`


			`## Install from Source`
			`The generic way is to install it as Python package using [PIP](https://pip.readthedocs.io/en/stable/installing/). First [install](https://borgbackup.readthedocs.io/en/stable/installation.html) Borg using the package of your distribution or via PyPI. The latter needs some additional [source packages](https://borgbackup.readthedocs.io/en/stable/installation.html#dependencies). Then install Vorta from PyPI. Your local Python version should be >= 3.6.`
			```
			`$ pip3 install vorta`
			```

Smaller issues for v0.6.5 (#123) * Clarify tray icon behavior in INSTALL.md. Fixes #111 * Rename default profile to just "Default". Fixes #116 * Remove Sentry bug reporting. Add link to Github instead. Fixes #117 * Log to terminal only when running in foreground. 2019-01-15 15:20:24 +00:00			`### Desktop Tray Icon`
			Unless Vorta is started with the `--foreground` option, it will minimize to the system tray without opening a settings window. Be sure your desktop environment supports tray icons by e.g. installing this [Gnome extension](https://extensions.gnome.org/extension/615/appindicator-support/).

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			`## Distribution Packages`
			`If available, prefer distribution-specific packages, as they offer better integration. (If you added Vorta to a Linux distribution, open an issue or PR and it will be added here.)`

			`### Apple macOS`
			`Install via [Homebrew Cask](https://brew.sh/) or download a pre-built app bundle for macOS (10.13+) from [Releases](https://github.com/borgbase/vorta/releases).`
			```
			`$ brew cask install vorta`
			```
			`### Arch Linux`
			`Use the [AUR package](https://aur.archlinux.org/packages/vorta/) maintained by [@bjo81](https://github.com/bjo81).`
			```
			`$ yaourt -S vorta`
			```