Commit Graph

190 Commits

Author SHA1 Message Date
Thomas Waldmann 22e021a5ce docs: install libcrypt-devel on cygwin
this is included into Python.h, thus needed when compiling stuff.
2019-03-19 22:38:09 +01:00
jminer74 a2c84215af docs/installation: added Alpine Linux to distribution list (#4414)
docs/installation: added Alpine Linux to distribution list
2019-03-01 22:11:48 +01:00
Thomas Waldmann 02f3c80d83 docs: tell that our binaries are amd/intel, bauerj has ARM
(cherry picked from commit 13986a1a6a)
2018-12-07 00:51:51 +01:00
Thomas Waldmann 8a09f26712 remove zeromq or python 3.5 references 2018-08-06 17:52:08 +02:00
James Rowell 34227430d4 Installation from source - setting python interpreter version (#3995)
explicit instructions for setting python interpreter when installing from source via git
2018-07-29 09:50:09 +01:00
Russell Davis 041f1baf4c
Update installation instructions for macOS
- Updated `OS X` to the new `macOS` name
- Fuse 3.x is no longer just a prerelease
- Added instructions to install fuse via homebrew
2018-07-06 18:46:18 -07:00
Thomas Waldmann 061321b668 update requirements and install docs about bundled lz4 and zstd 2017-12-18 22:55:00 +01:00
Thomas Waldmann fe48caf853 fix lz4 deprecation warning, require lz4 >= 1.7.0 (r129)
as we bundle lz4 1.8.0 now, platform not having a recent liblz4 can
now just use the bundled code.
2017-12-18 00:53:26 +01:00
Thomas Waldmann 61d6c58241 update / rephrase cygwin / WSL status, fixes #3174 2017-11-05 19:24:49 +01:00
TW ddecd4b618
Merge pull request #3182 from TBurchfield/master
Removal of |project_name|.
2017-11-01 02:41:02 +01:00
Svein Ove Aas 98443f15d5 Add Nix/NixOS install command 2017-10-20 17:08:10 +01:00
8bit 8d830d069f Removed all |project_name
| instances, replaced with Borg
2017-10-17 11:50:55 -05:00
Thomas Waldmann a5c6a50ebe increase Python minimum requirement to 3.5.0
also:
- drop testing on 3.4
- add some TODO for the docs and vagrant machines
2017-07-29 20:55:04 +02:00
Marian Beermann 55e0c43c53 add zeromq dependency 2017-07-29 11:58:01 +02:00
Marian Beermann 735339c209 docs: streamline installation: platforms table 2017-07-21 12:32:30 +02:00
Marian Beermann ab773956c1 docs: streamline installation (2)
I can't give a good reason why anyone would care about this here.
This is right before distribution packages, which are per definition
compatible (sometimes tested, even).

Instead, mention it where it applies.
2017-07-21 12:32:30 +02:00
Marian Beermann 3d5a8016e6 docs: streamline installation: file systems 2017-07-21 12:32:30 +02:00
Thomas Kluyver 0edad19ee0 Update source-install about doc dependencies
Closes gh-2795
2017-07-15 15:49:55 +02:00
Antonio Larrosa 6c7b9a338c Fix openSUSE command and add openSUSE section
Fix the name of the borgbackup package in openSUSE and
add an openSUSE section on how to install development dependencies
to build borgbackup from sources.
2017-07-04 12:27:58 +02:00
Thomas Waldmann 7ebad4f803 FUSE vs. fuse 2017-06-24 01:24:14 +02:00
Marian Beermann 7df1140ab9 docs: installation: fix accidental block quotes 2017-06-18 01:27:29 +02:00
Andrea Gelmini e4247cc0d2 Fix typos 2017-06-09 16:49:30 +02:00
Thomas Waldmann b484c79bc2 document follow_symlinks requirements, check libc, fixes #2507 2017-05-22 17:54:42 +02:00
Marian Beermann e036ebc340 docs: installation: pre-install considerations, fix crossrefs
posix_fadvise -> only used when available; not part of the filesystem.
sync -> fsync
2017-04-28 10:40:21 +02:00
Steve Groesz ff4120184c Fix formatting in pre-installation section
Some documentation was improperly formatted with #2392. This corrects those errors.
2017-04-26 22:25:15 -05:00
Steve Groesz 605f281b37 Document repository file system requirements
#2080
2017-04-23 12:48:28 +02:00
Thomas Waldmann 32c6e3ad95 docs: tell what kind of hardlinks we support 2017-04-05 13:03:58 +02:00
Thomas Waldmann b287fba22e fix caskroom link, fixes #2299 2017-03-15 01:22:21 +01:00
Florent Hemmi 1551be54be Docs: one link per distro in the installation page 2017-03-08 17:11:10 +01:00
Marian Beermann a9db2a2e55 Merge branch '1.0-maint' into master
# Conflicts:
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/helpers.py
2016-12-17 13:26:28 +01:00
Thomas Waldmann 6b6ddecd93 document windows 10 linux subsystem install
also add note about remote repos being broken on cygwin.
2016-12-17 00:25:49 +01:00
Thomas Waldmann a100fb67eb Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	AUTHORS
#	src/borg/archive.py
#	src/borg/key.py
2016-11-30 05:38:04 +01:00
Thomas Waldmann d6d3f275df docs: add python3-devel as a dependency for cygwin-based installation 2016-11-30 02:50:20 +01:00
enkore 223f7890fe Merge pull request #1819 from enkore/issue/1800
Add BLAKE2b key types
2016-11-11 03:11:38 +01:00
Marian Beermann a31ca4f022
crypto: link against system libb2, if possible 2016-11-11 03:08:11 +01:00
Marian Beermann 05a52ec8ec
Merge branch '1.0-maint' into merge/1.0-maint 2016-11-09 23:56:54 +01:00
Antoine Beaupré b4d0388785 move security verification to support section
the rationale is to simplify the README file to the bare
minimum. security researchers will be able to find the contact
information if they look minimally and people installing the software
will find a link where relevant (in binary releases only, since all
the others have other trust paths)
2016-11-04 20:58:27 -04:00
Thomas Waldmann dbe862f3d8 Merge branch '1.0-maint' into merge-1.0-maint 2016-08-06 01:24:22 +02:00
Thomas Waldmann 4e737cb64b OS X: install pkg-config to build with FUSE support 2016-07-30 21:08:20 +02:00
Marian Beermann 4e3bfabebf docs, platform/features: linux has BSD flag emulation 2016-07-30 00:01:05 +02:00
Marian Beermann ac8c8119a7
Merge branch '1.0-maint' into master 2016-07-28 00:29:43 +02:00
enkore f811624fab Merge pull request #1388 from enkore/f/document-platforms2
Platform feature matrix
2016-07-28 00:17:26 +02:00
Marian Beermann c5fffbefff Platform feature matrix 2016-07-27 23:54:15 +02:00
Lee Bousfield 0a4a95eb17
Remove trailing whitespace 2016-07-27 10:05:51 -04:00
Marian Beermann 2e6eb63174
Merge branch '1.0-maint' into master 2016-07-14 01:28:26 +02:00
Thomas Waldmann cf4d761042 docs: fix the highlighting
default is "python", that's why some help fragments and bash scripts looked strange.
2016-07-11 23:16:53 +02:00
Thomas Waldmann fe627246e4 Merge branch '1.0-maint' 2016-07-08 12:13:52 +02:00
Thomas Waldmann 7231107b5a update cygwin installation docs
cython is installed with pip later.
liblz4 is available from normal cygwin packages now.
creation of virtualenv worked now without issues.
2016-07-04 03:47:54 +02:00
anarcat 5167dca58c update install docs table again
* sort install list (fedora was out of place)
* add EPEL
* borg is not young anymore, warn about old distros
* more coherent *BSD ports naming
* add raspbian, openindiana and mageia
2016-06-04 10:42:07 -04:00
anarcat 0a30d40a9d fix debian sid cross-reference in install docs 2016-04-25 22:54:36 -04:00
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