rclone/docs/content/install.md

109 lines
2.7 KiB
Markdown
Raw Normal View History

---
title: "Install"
description: "Rclone Installation"
date: "2016-03-28"
2016-04-18 17:55:07 +00:00
---
# Install #
Rclone is a Go program and comes as a single binary file.
## Quickstart ##
* [Download](/downloads/) the relevant binary.
* Unpack and the `rclone` binary.
2017-03-29 09:06:22 +00:00
* Run `rclone config` to setup. See [rclone config docs](/docs/) for more details.
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`.
2017-12-04 20:58:14 +00:00
## Script installation ##
To install rclone on Linux/MacOs/BSD systems, run:
curl https://rclone.org/install.sh | sudo bash
For beta installation, run:
curl https://rclone.org/install.sh | sudo bash -s beta
## 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
unzip rclone-current-linux-amd64.zip
cd rclone-*-linux-amd64
Copy binary file
sudo cp rclone /usr/bin/
sudo chown root:root /usr/bin/rclone
sudo chmod 755 /usr/bin/rclone
Install manpage
sudo mkdir -p /usr/local/share/man/man1
sudo cp rclone.1 /usr/local/share/man/man1/
sudo mandb
2017-03-29 09:06:22 +00:00
Run `rclone config` to setup. See [rclone config docs](/docs/) for more details.
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
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 mkdir -p /usr/local/bin
sudo mv rclone /usr/local/bin/
(the `mkdir` command is safe to run, even if the directory already exists).
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.
rclone config
## Install from source ##
Make sure you have at least [Go](https://golang.org/) 1.6 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
this
go get -u -v github.com/ncw/rclone/...
## Installation with Ansible ##
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
```