mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
borg/docs/installation.rst

66 lines
1.7 KiB
ReStructuredText
Raw Normal View History

Added more installation documentation.
2013-06-30 19:30:17 +00:00
.. include:: global.rst.inc
.. _installation:
Installation
More documentation work
2013-07-31 18:51:01 +00:00
============
Added more installation documentation.
2013-06-30 19:30:17 +00:00
Minor docs tweaks
2013-07-03 20:38:07 +00:00
|project_name| requires Python_ 3.2 or above to work. Even though Python 3 is
Various minor documentation updates: mention sshfs, Linux packages, minor changes to prose, etc.
2014-02-04 02:26:36 +00:00
not the default Python version on most Linux distributions, it is usually
Added more installation documentation.
2013-06-30 19:30:17 +00:00
available as an optional install.
Other dependencies:
* `msgpack-python`_ >= 0.1.10
* OpenSSL_ >= 1.0.0
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-16 03:02:43 +00:00
* libacl_
Added more installation documentation.
2013-06-30 19:30:17 +00:00
Updated documentation
2013-07-30 11:54:04 +00:00
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.
Added more installation documentation.
2013-06-30 19:30:17 +00:00
Various minor documentation updates: mention sshfs, Linux packages, minor changes to prose, etc.
2014-02-04 02:26:36 +00:00
The llfuse_ python package is also required if you wish to mount an
archive as a FUSE filesystem.
Improve installatoin instructions. Specifically refer to pip3 instead of pip to avoid potential confusion. Also mention virtualenv
2015-04-27 20:35:06 +00:00
Virtualenv_ can be used to build and install |project_name|
without affecting the system Python or requiring root access.
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-16 03:02:43 +00:00
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
Added more installation documentation.
2013-06-30 19:30:17 +00:00
Installing from PyPI using pip
------------------------------
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-16 03:02:43 +00:00
To install |project_name| system-wide::
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS use borg instead attic except at the places where it was used: - as toplevel package name, directory name, file name - to refer to original attic remove sphinx upload make command, will be replaced by github.io site later remove references to binary downloads and linux packages for now remove some software name references, fix grammar use borgbackup rather than borg-backup (or borg) in URLs, less name collision issues, better search results, no validity issues with "-"
2015-05-09 16:40:55 +00:00
$ sudo pip3 install borgbackup
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-16 03:02:43 +00:00
To install it in a user-specific account::
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS use borg instead attic except at the places where it was used: - as toplevel package name, directory name, file name - to refer to original attic remove sphinx upload make command, will be replaced by github.io site later remove references to binary downloads and linux packages for now remove some software name references, fix grammar use borgbackup rather than borg-backup (or borg) in URLs, less name collision issues, better search results, no validity issues with "-"
2015-05-09 16:40:55 +00:00
$ pip3 install --user borgbackup
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-16 03:02:43 +00:00
Then add ``$HOME/.library/bin`` to your ``$PATH``.
Added more installation documentation.
2013-06-30 19:30:17 +00:00
Installing from source tarballs
-------------------------------
Update documentation
2013-07-08 19:19:50 +00:00
.. parsed-literal::
Added more installation documentation.
2013-06-30 19:30:17 +00:00
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS use borg instead attic except at the places where it was used: - as toplevel package name, directory name, file name - to refer to original attic remove sphinx upload make command, will be replaced by github.io site later remove references to binary downloads and linux packages for now remove some software name references, fix grammar use borgbackup rather than borg-backup (or borg) in URLs, less name collision issues, better search results, no validity issues with "-"
2015-05-09 16:40:55 +00:00
$ curl -O :targz_url:`Borg`
Project rename
2013-07-08 21:38:27 +00:00
$ tar -xvzf |package_filename|
Update documentation
2013-07-08 19:19:50 +00:00
$ cd |package_dirname|
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-16 03:02:43 +00:00
$ sudo python3 setup.py install
Added more installation documentation.
2013-06-30 19:30:17 +00:00
Installing from git
-------------------
Project rename
2013-07-08 21:38:27 +00:00
.. parsed-literal::
Added more installation documentation.
2013-06-30 19:30:17 +00:00
Project rename
2013-07-08 21:38:27 +00:00
$ git clone |git_url|
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS use borg instead attic except at the places where it was used: - as toplevel package name, directory name, file name - to refer to original attic remove sphinx upload make command, will be replaced by github.io site later remove references to binary downloads and linux packages for now remove some software name references, fix grammar use borgbackup rather than borg-backup (or borg) in URLs, less name collision issues, better search results, no validity issues with "-"
2015-05-09 16:40:55 +00:00
$ cd borg
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-16 03:02:43 +00:00
$ sudo python3 setup.py install
Documentation update. Added links to Debian, Ubuntu and Arch linux packages and added a comment about Cython dependency when installing from git. Closes #21.
2014-01-26 11:51:56 +00:00
Various minor documentation updates: mention sshfs, Linux packages, minor changes to prose, etc.
2014-02-04 02:26:36 +00:00
Please note that when installing from git, Cython_ is required to generate some files that
Documentation update. Added links to Debian, Ubuntu and Arch linux packages and added a comment about Cython dependency when installing from git. Closes #21.
2014-01-26 11:51:56 +00:00
are normally bundled with the release tarball.