Commit Graph

190 Commits

Author SHA1 Message Date
TW a220a2d617 Merge pull request #969 from rumpelsepp/patch-2
docs/installation: Add FreeBSD Ports tree
2016-04-23 13:55:37 +02:00
Janne K 61a8ff40f3 Package is not needed in Korora 2016-04-23 11:51:38 +03:00
Stefan Tatschner ab4a1a1025 docs/installation: Add FreeBSD Ports tree
https://svnweb.freebsd.org/ports?view=revision&revision=413469

It is not yet in "pkg"; that will automatically happen in the next quarterly period.
2016-04-23 09:02:02 +02:00
Janne K 257995d185 Fix Fedora installation instructions
Update installation instructions so that the following error won't occur:

gcc: error: /usr/lib/rpm/redhat/redhat-hardened-cc1: No such file or directory
error: command 'gcc' failed with exit status 1
2016-04-22 17:07:31 +03:00
Hans-Peter Jansen 4bf40f4178 Fix package naming for openSUSE 2016-04-11 10:08:16 +02:00
Benjamin Pereto 1e1dae3bb6 added package docs for fedora 2016-04-10 17:55:36 +02:00
TW ea1ebb80bf Merge pull request #868 from anarcat/patch-2
add link to OpenBSD port and OpenSUSE
2016-04-10 17:06:45 +02:00
anarcat 17c0a3a8fa cleanup ubuntu in install list
ubuntu was showing up twice in the list of supported OSes... it seems it was because the line was getting too long, so I removed the "names" and kept only the numbers to keep the line short.
2016-04-09 16:27:43 -04:00
anarcat 3cd6f52521 add link to OpenBSD port and OpenSUSE
see the ever-growing #105
2016-04-09 16:19:03 -04:00
anarcat 287f49503b add jessie-backports to supported platforms
see #105
2016-04-03 12:23:32 -04:00
Thomas Waldmann d6b85a6a3b Merge branch 'packaged-for-guix' of https://github.com/lfam/borg into lfam-packaged-for-guix 2016-03-26 14:20:48 +01:00
infectormp 7412e30977 Installation: Mention Gentoo package
docs/installation.rst: Add Gentoo package to list of distribution packages.
2016-03-25 09:21:18 +03:00
lfam 587abf5376 Installation: Mention GNU Guix package.
* docs/installation.rst: Add GNU Guix package to list of distribution packages.
2016-03-25 00:13:24 -04:00
Thomas Waldmann de7582a9d7 Merge branch '1.0-maint' 2016-03-21 16:13:08 +01:00
Thomas Waldmann 40dbb7411c fix cygwin requirements (gcc-g++) 2016-03-21 16:11:43 +01:00
Daniel Reichelt e1f6a34820 provide wrapper for borg mount, fixes #743
- add archiver.main_mount()

- provide borgfs behaviour when the monolithic binary is called via a
  symlink called borgfs

- docs: update usage of mount subcommand, provide examples for borgfs and
  add symlink creation to standalone binary installation

- run build_usage

- add entry point in setup.py

- patch helpers.py:get_keys_dir() to allow mounting fstab entries with
  "user" option set

  Without this, setuid() called at some point by mount changes the HOME
  environment variable to '/root' and os.expanduser('~') would return
  '/root' as well, thus the mount would fail with
 	 PermissionError: [Errno 13] Permission denied: '/root/.config'
  After setuid(), the HOME variable stays intact, so we still can
  explicitly query USER's home.

  Also, os.path.expanduser() behaves differently for '~' and '~someuser'
  as parameters: when called with an explicit username, the possibly set
  environment variable HOME is no longer respected. So we have to check if
  it is set and only expand the user's home directory if HOME is unset.

- add myself to AUTHORS
2016-03-17 01:40:17 +01:00
Thomas Waldmann af2eaaabd4 update and improve docs
use the travis status image as png as svg does not show an image in firefox.
2016-02-27 17:22:56 +01:00
jungle-boogie 1d4f591691 updated freeBSD docs
With the now improved steps, I was able to build Borg on a vagrant image:
% borg -V
borg 1.0.0rc2.dev40+ngfb83f61
2016-02-20 14:12:57 -08:00
jungle-boogie fdf1dd75dd freebsd fuse for mount for #649 2016-02-20 10:24:43 -08:00
Thomas Waldmann 5e5911dd49 docs: add a hint about the dev headers needed when installing from source 2016-02-18 21:30:44 +01:00
Thomas Waldmann 2f95c8ea79 docs: use pip extras or requirements file to install llfuse 2016-02-07 19:15:30 +01:00
Thomas Waldmann c2edfab237 all FUSE related version requirements in 1 place 2016-02-07 19:08:03 +01:00
Thomas Waldmann 69300e473d document and automate llfuse requirement 2016-02-07 19:03:32 +01:00
Thomas Waldmann 4355150efa docs: OS X binary does not work for older OS X releases, fixes #629 2016-02-04 20:48:43 +01:00
Thomas Waldmann 435d30d61b docs: updates and fixes 2016-02-01 03:22:02 +01:00
Gianfranco Costamagna 37eb22ad55 Delete Ubuntu Vivid, EOL
Ubuntu Vivid is not supported anymore.
2016-01-25 09:07:30 +01:00
Thomas Waldmann a2843bc939 docs: require python 3.4+
remove references to older pythons.
2016-01-24 14:57:48 +01:00
Antoine Beaupré da7bc4af94 add netbsd install instructions 2016-01-22 14:35:53 -05:00
Thomas Waldmann 92969ea5f1 add gcc gcc-c++ to redhat/fedora/corora install docs 2016-01-22 14:03:48 +01:00
Gianfranco Costamagna e644dae793 Move to my ppa and add Trusty/Vivid packages 2016-01-15 13:55:04 +01:00
Antoine Beaupré 77238d175c fix table syntax and links 2016-01-13 15:23:34 -05:00
Antoine Beaupré cd14b766ca add NixOS 2016-01-13 15:18:19 -05:00
Antoine Beaupré 178b9dc151 sort OS list alphabetically 2016-01-13 15:18:03 -05:00
Antoine Beaupré 3e434ce6fb mention debian testing, ubuntu backport 2016-01-13 15:17:54 -05:00
Michael Gajda fb64173bb4 Documentation: Standalone binary / pyinstaller extracts dependencies into /tmp. Currently /tmp requires about ~28MB of free space. It also needs exec permissions.
Closes #499
2016-01-06 13:35:28 +01:00
Fabian Weisshaar eb642f06cc Allow simple copy-paste for package installation with apt 2015-12-30 15:06:31 +01:00
Stefan Tatschner f1b9b95e0d Fix wrong installation instructions for archlinux
On arch I don't want to perform a full system upgrade when
installing a new package; so let's drop the "yu" part.
2015-12-08 19:15:03 +01:00
Vlad 5280c0830e Borg moved to Arch Linux [community] 2015-12-02 00:16:25 +02:00
Thomas Waldmann 57ffa4d648 more precise binary installation steps 2015-11-20 15:49:53 +01:00
Antoine Beaupré 917236231f correct ubuntu release number 2015-11-16 09:07:59 -05:00
Antoine Beaupré 3bbd3319a4 use 'distribution' more consistently 2015-11-15 22:43:08 -05:00
Antoine Beaupré d78d6d60b1 turn distro list into a table, adding Debian, Ubuntu, OSX 2015-11-15 22:40:00 -05:00
Antoine Beaupré 2c3f3f1b07 install docs: don't use "from" twice
it always abstracts "pypi" and "github" away (technical words that are
not necessary). pip remains.
2015-11-15 22:20:07 -05:00
Thomas Waldmann 0070ef0c4a minor install docs fixes 2015-11-15 20:23:33 +01:00
Antoine Beaupré aa4c76872c move pyinstaller mention out of heading
pyinstaller probably means nothing for most people, while standalone binary is more meaningful
2015-11-14 21:08:28 -05:00
Antoine Beaupré a8d2c18fee split packaging meta-info in a separate paragraph and link to github 2015-11-14 21:07:16 -05:00
Antoine Beaupré 9f8700e383 restructure install page headings
do not repeat "installation" all the time, and regroup git and pip under "from source"

also link to the sections in the summary
2015-11-14 21:03:38 -05:00
Jakob Schnitzer 7cc3becad9 docs: restructure installation.rst, add OSX instructions
Moved the list of dependencies to the corresponding subsection.
Collected all preparation steps under one heading.
Added link to the Arch Linux AUR package.
Install docs for OS X.
2015-10-17 18:40:15 +02:00
Jakob Schnitzer da926f2eb4 docs: fix code blocks in installation.rst
In one case removed the |project_name| and |git_url| variables to fix
the display of the code block. Shouldn't be problematic, as they are not
used consistently in this document anyway.

Put two notes in their own nice '.. note::' blocks.
2015-10-13 17:25:52 +02:00
Thomas Waldmann 04ac82d3e2 do binary releases via "github releases", closes #214 2015-10-07 15:41:17 +02:00
Thomas Waldmann 30bd38b51b update linux glibc requirement (binaries built on debian7 now) 2015-10-07 15:08:09 +02:00
Thomas Waldmann ee66c4c435 remove docs about binary wheels
we stop supporting them, because there are better alternatives:
- use a distribution package (from your linux distribution), if available
- use a pyinstaller binary provided by us (they include all you need in 1 file and
  thus have better compatibility properties and are easier to install than a wheel)
- install from source (pypi or git) if everything else fails
2015-10-06 21:49:21 +02:00
Thomas Waldmann 524ca297ea document binary and non-binary requirements 2015-09-28 00:22:20 +02:00
Thomas Waldmann 7dbe2b80b3 docs: add a note about the single-file binaries 2015-09-21 21:28:18 +02:00
Thomas Waldmann fb8d1cc602 also mention libattr
ACLs are implemented as xattrs, so libattr is pulled in as a dependency of libacl.
2015-09-19 20:31:26 +02:00
Thomas Waldmann d74da7c031 llfuse 0.41 install troubles on some platforms, require < 0.41
UnicodeDecodeError exception due to non-ascii llfuse setup.py
2015-09-12 19:26:46 +02:00
Thomas Waldmann e8f4fe0b88 pkg-config is needed for llfuse installation 2015-09-12 19:19:52 +02:00
Thomas Waldmann e4dc482598 docs: quickstart: key modes, cosmetic changes 2015-08-29 03:39:53 +02:00
Thomas Waldmann cebb61d8dd docs: add pypi, wheel, dist package based install docs 2015-08-29 02:55:09 +02:00
Thomas Waldmann 79d7f49a44 docs: split install into system-specific preparations and generic instructions 2015-08-29 01:17:19 +02:00
Thomas Waldmann ee58d4f074 docs: be more specific about Debian/Ubuntu release 2015-08-29 00:45:54 +02:00
Per Guth 0926c2821f docs: installation: korora/fedora -> `lz4-devel` 2015-08-17 17:10:37 +02:00
Thomas Waldmann bf757738f7 Merge branch 'master' into compression 2015-08-14 23:24:04 +02:00
Thomas Waldmann feff0f0c94 install docs: replace hack for llfuse with proper solution
found out why it could not install llfuse into virtual env: it always complained about
not being able to find fuse.pc - which is part of libfuse-dev / fuse-devel and was missing.

once one adds the fuse dev stuff, llfuse installs to virtual env without problems.
2015-08-12 03:15:44 +02:00
Thomas Waldmann 27de1b0a43 add a wrapper around liblz4 2015-08-01 15:07:54 +02:00
Thomas Waldmann fb998cbd66 docs: add note about how to run borg from virtual env 2015-07-26 14:47:18 +02:00
Thomas Waldmann 859c33d42b docs: add solutions for (ll)fuse installation problems 2015-07-25 19:07:24 +02:00
Thomas Waldmann 12a50bc6fe tested and updated cygwin docs, thanks to fvia 2015-07-25 18:38:16 +02:00
Thomas Harold e3472a248a Fix format issue in installation.rst for Cygwin
Fixed formatting issue in installation.rst where packages were listed all on one line.
2015-07-16 16:40:33 -04:00
Thomas Waldmann f330b4bd2a some doc updates, see below
faq about redundancy / integrity
compression is optional
having borg installed on backup server is optional (but faster)
cygwin installation tipps
do not document passphrase encryption mode example, use keyfile mode
2015-07-14 21:31:35 +02:00
Per Guth e168b41406 Update installation.rst 2015-06-15 14:40:11 +02:00
Per Guth 041357e48a Update installation.rst
Replicated Ubuntus dependency list.
2015-06-15 14:39:04 +02:00
Per Guth 1dc00e7937 Update installation.rst
please test on fresh installation.
2015-06-15 13:09:39 +02:00
Thomas Waldmann dd78e1a56e improve docs, usage help, changelog 2015-06-11 22:18:12 +02:00
Thomas Waldmann 906ea629f6 use py.test for testing, document it
locally (via tox) and also on travis ci.
2015-05-22 21:26:41 +02:00
Thomas Waldmann f30d05fcd4 docs: install docs, faq improvements, other minor changes 2015-05-14 20:47:08 +02:00
Thomas Waldmann cb5c9b63b3 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-13 15:02:33 +02:00
Thomas Waldmann f9d90482c4 merged master 2015-05-10 16:36:10 +02:00
Jonas Borgström c79b5357f8 Improve installatoin instructions.
Specifically refer to pip3 instead of pip to avoid potential
confusion.

Also mention virtualenv
2015-04-27 22:35:06 +02:00
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
Jonas Borgström 7ce3290fb2 docs: Added link to prebuilt Linux binaries. 2014-06-29 14:24:45 +02:00
Jonas Borgström c20aba8c4c docs: Add link to Slackware packages 2014-03-12 21:00:30 +01:00
Dan Christensen 0b9969d162 Various minor documentation updates: mention sshfs, Linux packages,
minor changes to prose, etc.
2014-02-03 21:26:36 -05:00
Jonas Borgström 9c80089c04 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 12:51:56 +01:00
Jonas Borgström b6c8392c03 More documentation work 2013-08-03 13:05:06 +02:00
Jonas Borgström 43a4bf6829 Updated documentation 2013-07-30 13:54:04 +02:00
Jonas Borgström b718a443a8 Project rename 2013-07-09 20:14:18 +02:00
Jonas Borgström a9272ce913 Update documentation 2013-07-08 21:19:50 +02:00
Jonas Borgström 6052a1ed74 Minor docs tweaks 2013-07-03 22:38:07 +02:00
Jonas Borgström 445b862d8c Added more installation documentation. 2013-06-30 21:30:17 +02:00