1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-27 18:28:42 +00:00
borg/docs/installation.rst
Antoine Beaupré ac87360c7c document better different dependencies
this is written with recent Ubuntu and Debian in mind, but should be
working everywhere. the idea here is to make sure anyone can install
this without knowning too much about ACLs or anything similar.

closes #135
2014-12-15 22:07:05 -05:00

74 lines
1.9 KiB
ReStructuredText

.. include:: global.rst.inc
.. _installation:
Installation
============
|project_name| requires Python_ 3.2 or above to work. Even though Python 3 is
not the default Python version on most Linux distributions, it is usually
available as an optional install.
Other dependencies:
* `msgpack-python`_ >= 0.1.10
* OpenSSL_ >= 1.0.0
* libacl_
The OpenSSL version bundled with Mac OS X and FreeBSD is most likey too old.
Newer versions are available from homebrew_ on OS X and from FreeBSD ports.
The llfuse_ python package is also required if you wish to mount an
archive as a FUSE filesystem.
Common compilation pre-requisites
---------------------------------
The following Debian packages are generally necessary to compile
|project_name|, either through pip, the tarball or git::
$ sudo apt-get install python3 python3-dev python3-msgpack python3-sphinx libssl-dev libacl1-dev
Installing from PyPI using pip
------------------------------
To install |project_name| system-wide::
$ sudo pip3 install Attic
To install it in a user-specific account::
$ pip3 install --user Attic
Then add ``$HOME/.library/bin`` to your ``$PATH``.
Installing from source tarballs
-------------------------------
.. parsed-literal::
$ curl -O :targz_url:`Attic`
$ tar -xvzf |package_filename|
$ cd |package_dirname|
$ sudo python3 setup.py install
Installing from git
-------------------
.. parsed-literal::
$ git clone |git_url|
$ cd attic
$ sudo python3 setup.py install
Please note that when installing from git, Cython_ is required to generate some files that
are normally bundled with the release tarball.
Packages
--------
|project_name| is also part of the Debian_, Ubuntu_, `Arch Linux`_ and Slackware_
distributions of GNU/Linux.
Standalone binaries
-------------------
Prebuilt standalone binaries that work on
most Linux systems can be found :artifacts:`here <>`.