Documentation as part of #1074 - added INSTALLING.md to clarify aspects of packagecloud installs and linked from README.md.

Signed-off-by: Brett Randall <javabrett@gmail.com>
This commit is contained in:
Brett Randall 2016-04-07 07:59:50 +10:00
parent 3671987c9b
commit 4b2d5f6dc4
2 changed files with 41 additions and 1 deletions

40
INSTALLING.md Normal file

@ -0,0 +1,40 @@
# Installing on Linux using packagecloud
[packagecloud](https://packagecloud.io) hosts [`git-lfs` packages](https://packagecloud.io/github/git-lfs) for popular Linux distributions with Apt/deb and Yum/rpm based package-managers. Installing from packagecloud is reasonably straightforward and involves:
* Adding the packagecloud repo that best matches your Linux distribution and version, then
* Running your package-manager's install command
## Adding the packagecloud repository
packagecloud provides scripts to automate the process of configuring the package repository on your system, importing signing-keys etc. These scripts must be run sudo root, and you should review them first. The scripts are:
* Apt/deb repositories: https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh
* Yum/rpm repositories: https://packagecloud.io/install/repositories/github/git-lfs/script.rpm.sh
The scripts check your Linux distribution and version, and use those parameters to create the best repository URL. If you are running one of the distributions listed for the latest version of Git LFS listed at [packagecloud](https://packagecloud.io/github/git-lfs) e.g `debian/jessie`, `el/7`, you can run the script without parameters:
Apt/deb repos:
`curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash`
Yum/rpm repos:
`curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.rpm.sh | sudo bash`
If you are running a disribution which does not match exactly a repository uploaded for Git LFS, but for which there is a repository for a compatible upstream distribution, you can either run the script with some additional parameters, or run it and then manually-correct the resulting repository URLs. See #1074 for details.
If you are running LinuxMint 17.1 Rebecca, which is downstream of Ubuntu Trusty and Debian Jessie, you can run:
`curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | os=debian dist=jessie sudo -E sudo bash`
The `os` and `dist` variables passed-in will override what would be detected for your system and force the selection of the upstream distribution's repository.
## Installing packages
With the packagecloud repository configured for your system, you can install Git LFS:
* Apt/deb: `sudo apt-get install git-lfs`
* Yum/rpm: `sudo yum install git-lfs`
## A note about proxies
Several of the commands above assume internet access and use `sudo`. If your host is behind a proxy-server that is required for internet access, you may depend on environment-variables `http_proxy` or `https_proxy` being set, and these might not survive the switch to root with `sudo`, which resets environment by-default. To get around this, you can run `sudo` with the `-E` switch, `sudo -E ...`, which retains environment variables.

@ -12,7 +12,7 @@ binaries available for Mac, Windows, Linux, and FreeBSD. Check out the
You can install Git LFS in several different ways, depending on your setup and
preferences.
* Linux users can install Debian or RPM packages from [PackageCloud](https://packagecloud.io/github/git-lfs/install).
* Linux users can install Debian or RPM packages from [PackageCloud](https://packagecloud.io/github/git-lfs/install). See the [Installaton Guide](./INSTALLING.md) for details.
* Mac users can install from [Homebrew](https://github.com/Homebrew/homebrew) with `brew install git-lfs`.
* Windows users can install from [Chocolatey](https://chocolatey.org/) with `choco install git-lfs.install`.
* [Binary packages are available][rel] for Windows, Mac, Linux, and FreeBSD.