2015-06-06 09:05:21 +00:00
|
|
|
---
|
|
|
|
title: "Install"
|
|
|
|
description: "Rclone Installation"
|
2018-08-28 14:30:47 +00:00
|
|
|
date: "2018-08-28"
|
2016-04-18 17:55:07 +00:00
|
|
|
---
|
2015-06-06 09:05:21 +00:00
|
|
|
|
2016-10-06 16:20:45 +00:00
|
|
|
# Install #
|
2015-06-06 09:05:21 +00:00
|
|
|
|
|
|
|
Rclone is a Go program and comes as a single binary file.
|
|
|
|
|
2016-10-06 16:20:45 +00:00
|
|
|
## Quickstart ##
|
2015-06-06 09:05:21 +00:00
|
|
|
|
2016-10-06 16:20:45 +00:00
|
|
|
* [Download](/downloads/) the relevant binary.
|
2018-08-28 14:30:47 +00:00
|
|
|
* Extract the `rclone` or `rclone.exe` binary from the archive
|
2017-03-29 09:06:22 +00:00
|
|
|
* Run `rclone config` to setup. See [rclone config docs](/docs/) for more details.
|
2015-06-06 09:05:21 +00:00
|
|
|
|
2016-10-06 16:20:45 +00:00
|
|
|
See below for some expanded Linux / macOS instructions.
|
2015-06-14 14:04:39 +00:00
|
|
|
|
|
|
|
See the [Usage section](/docs/) of the docs for how to use rclone, or
|
2015-06-06 09:05:21 +00:00
|
|
|
run `rclone -h`.
|
2015-06-28 09:38:27 +00:00
|
|
|
|
2017-12-04 20:58:14 +00:00
|
|
|
## Script installation ##
|
|
|
|
|
2018-02-08 14:56:39 +00:00
|
|
|
To install rclone on Linux/macOS/BSD systems, run:
|
2017-12-04 20:58:14 +00:00
|
|
|
|
|
|
|
curl https://rclone.org/install.sh | sudo bash
|
|
|
|
|
|
|
|
For beta installation, run:
|
|
|
|
|
|
|
|
curl https://rclone.org/install.sh | sudo bash -s beta
|
|
|
|
|
2017-12-14 11:00:22 +00:00
|
|
|
Note that this script checks the version of rclone installed first and
|
|
|
|
won't re-download if not needed.
|
|
|
|
|
2016-10-06 16:20:45 +00:00
|
|
|
## Linux installation from precompiled binary ##
|
|
|
|
|
|
|
|
Fetch and unpack
|
|
|
|
|
2017-03-29 09:06:22 +00:00
|
|
|
curl -O https://downloads.rclone.org/rclone-current-linux-amd64.zip
|
2016-10-06 16:20:45 +00:00
|
|
|
unzip rclone-current-linux-amd64.zip
|
|
|
|
cd rclone-*-linux-amd64
|
|
|
|
|
|
|
|
Copy binary file
|
2015-06-28 09:38:27 +00:00
|
|
|
|
2017-02-26 10:09:23 +00:00
|
|
|
sudo cp rclone /usr/bin/
|
|
|
|
sudo chown root:root /usr/bin/rclone
|
|
|
|
sudo chmod 755 /usr/bin/rclone
|
2016-10-06 16:20:45 +00:00
|
|
|
|
|
|
|
Install manpage
|
|
|
|
|
2015-06-28 09:38:27 +00:00
|
|
|
sudo mkdir -p /usr/local/share/man/man1
|
|
|
|
sudo cp rclone.1 /usr/local/share/man/man1/
|
|
|
|
sudo mandb
|
2016-07-09 12:47:55 +00:00
|
|
|
|
2017-03-29 09:06:22 +00:00
|
|
|
Run `rclone config` to setup. See [rclone config docs](/docs/) for more details.
|
2016-10-06 16:20:45 +00:00
|
|
|
|
|
|
|
rclone config
|
|
|
|
|
|
|
|
## macOS installation from precompiled binary ##
|
|
|
|
|
|
|
|
Download the latest version of rclone.
|
|
|
|
|
2017-03-29 09:06:22 +00:00
|
|
|
cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip
|
2016-10-06 16:20:45 +00:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2017-09-26 14:58:03 +00:00
|
|
|
sudo mkdir -p /usr/local/bin
|
2016-10-06 16:20:45 +00:00
|
|
|
sudo mv rclone /usr/local/bin/
|
|
|
|
|
2017-09-26 14:58:03 +00:00
|
|
|
(the `mkdir` command is safe to run, even if the directory already exists).
|
|
|
|
|
2016-10-06 16:20:45 +00:00
|
|
|
Remove the leftover files.
|
|
|
|
|
|
|
|
cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip
|
|
|
|
|
2017-03-29 09:06:22 +00:00
|
|
|
Run `rclone config` to setup. See [rclone config docs](/docs/) for more details.
|
2016-10-06 16:20:45 +00:00
|
|
|
|
|
|
|
rclone config
|
|
|
|
|
|
|
|
## Install from source ##
|
|
|
|
|
2018-08-28 14:30:47 +00:00
|
|
|
Make sure you have at least [Go](https://golang.org/) 1.7
|
|
|
|
installed. [Download go](https://golang.org/dl/) if necessary. The
|
|
|
|
latest release is recommended. Then
|
2016-10-06 16:20:45 +00:00
|
|
|
|
2019-07-28 17:47:38 +00:00
|
|
|
git clone https://github.com/rclone/rclone.git
|
2018-08-28 14:30:47 +00:00
|
|
|
cd rclone
|
|
|
|
go build
|
|
|
|
./rclone version
|
|
|
|
|
|
|
|
You can also build and install rclone in the
|
|
|
|
[GOPATH](https://github.com/golang/go/wiki/GOPATH) (which defaults to
|
|
|
|
`~/go`) with:
|
2016-10-06 16:20:45 +00:00
|
|
|
|
2019-07-28 17:47:38 +00:00
|
|
|
go get -u -v github.com/rclone/rclone
|
2016-10-06 16:20:45 +00:00
|
|
|
|
2018-08-28 14:30:47 +00:00
|
|
|
and this will build the binary in `$GOPATH/bin` (`~/go/bin/rclone` by
|
|
|
|
default) after downloading the source to
|
2019-07-28 17:47:38 +00:00
|
|
|
`$GOPATH/src/github.com/rclone/rclone` (`~/go/src/github.com/rclone/rclone`
|
2018-08-28 14:30:47 +00:00
|
|
|
by default).
|
2016-10-06 16:20:45 +00:00
|
|
|
|
|
|
|
## Installation with Ansible ##
|
2016-07-09 12:47:55 +00:00
|
|
|
|
|
|
|
This can be done with [Stefan Weichinger's ansible
|
|
|
|
role](https://github.com/stefangweichinger/ansible-rclone).
|
|
|
|
|
|
|
|
Instructions
|
|
|
|
|
|
|
|
1. `git clone https://github.com/stefangweichinger/ansible-rclone.git` into your local roles-directory
|
|
|
|
2. add the role to the hosts you want rclone installed to:
|
|
|
|
|
|
|
|
```
|
|
|
|
- hosts: rclone-hosts
|
|
|
|
roles:
|
|
|
|
- rclone
|
|
|
|
```
|