From ec7cef98d8d99b200980a53dfc37f1ce9348ae86 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Thu, 6 Oct 2016 17:20:45 +0100 Subject: [PATCH] Update installation docs with macOS walkthrough from Spencer Charest --- docs/content/install.md | 87 +++++++++++++++++++++++++++++------------ 1 file changed, 63 insertions(+), 24 deletions(-) diff --git a/docs/content/install.md b/docs/content/install.md index 7ee3387b4..6b04ba809 100644 --- a/docs/content/install.md +++ b/docs/content/install.md @@ -4,16 +4,73 @@ description: "Rclone Installation" date: "2016-03-28" --- -Install -------- +# Install # Rclone is a Go program and comes as a single binary file. -[Download](/downloads/) the relevant binary. +## Quickstart ## -Or alternatively if you have Go 1.5+ installed use + * [Download](/downloads/) the relevant binary. + * Unpack and the `rclone` binary. + * Run `rclone config` to setup. See [rclone config docs](http://rclone.org/docs/) for more details. - go get github.com/ncw/rclone +See below for some expanded Linux / macOS instructions. + +See the [Usage section](/docs/) of the docs for how to use rclone, or +run `rclone -h`. + +## Linux installation from precompiled binary ## + +Fetch and unpack + + curl -O http://downloads.rclone.org/rclone-current-linux-amd64.zip + unzip rclone-current-linux-amd64.zip + cd rclone-*-linux-amd64 + +Copy binary file + + sudo cp rclone /usr/sbin/ + sudo chown root:root /usr/sbin/rclone + sudo chmod 755 /usr/sbin/rclone + +Install manpage + + sudo mkdir -p /usr/local/share/man/man1 + sudo cp rclone.1 /usr/local/share/man/man1/ + sudo mandb + +Run `rclone config` to setup. See [rclone config docs](http://rclone.org/docs/) for more details. + + rclone config + +## macOS installation from precompiled binary ## + +Download the latest version of rclone. + + cd && curl -O http://downloads.rclone.org/rclone-current-osx-amd64.zip + +Unzip the download and cd to the extracted folder. + + unzip -a rclone-current-osx-amd64.zip && cd rclone-*-osx-amd64 + +Move rclone to your $PATH. You will be prompted for your password. + + sudo mv rclone /usr/local/bin/ + +Remove the leftover files. + + cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip + +Run `rclone config` to setup. See [rclone config docs](http://rclone.org/docs/) for more details. + + rclone config + +## Install from source ## + +Make sure you have at least [Go](https://golang.org/) 1.5 installed. +Make sure your `GOPATH` is set, then: + + go get -u -v github.com/ncw/rclone and this will build the binary in `$GOPATH/bin`. If you have built rclone before then you will want to update its dependencies first with @@ -21,25 +78,7 @@ this go get -u -v github.com/ncw/rclone/... -See the [Usage section](/docs/) of the docs for how to use rclone, or -run `rclone -h`. - -linux binary downloaded files install example -------- - - unzip rclone-v1.17-linux-amd64.zip - cd rclone-v1.17-linux-amd64 - #copy binary file - sudo cp rclone /usr/sbin/ - sudo chown root:root /usr/sbin/rclone - sudo chmod 755 /usr/sbin/rclone - #install manpage - sudo mkdir -p /usr/local/share/man/man1 - sudo cp rclone.1 /usr/local/share/man/man1/ - sudo mandb - -Installation with Ansible -------- +## Installation with Ansible ## This can be done with [Stefan Weichinger's ansible role](https://github.com/stefangweichinger/ansible-rclone).