From c7329d2eceb4b431221e3a83c7ed313ef731c3fa Mon Sep 17 00:00:00 2001 From: albertony <12441419+albertony@users.noreply.github.com> Date: Sat, 25 Sep 2021 21:05:41 +0200 Subject: [PATCH] docs: add section in install documentation about portable install See #5591 --- docs/content/install.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/content/install.md b/docs/content/install.md index a64676968..1877f0f26 100644 --- a/docs/content/install.md +++ b/docs/content/install.md @@ -10,7 +10,7 @@ Rclone is a Go program and comes as a single binary file. ## Quickstart ## * [Download](/downloads/) the relevant binary. - * Extract the `rclone` or `rclone.exe` binary from the archive + * Extract the `rclone` executable, `rclone.exe` on Windows, from the archive. * Run `rclone config` to setup. See [rclone config docs](/docs/) for more details. * Optionally configure [automatic execution](#autostart). @@ -228,6 +228,26 @@ Instructions - rclone ``` +## Portable installation ## + +As mentioned [above](https://rclone.org/install/#quickstart), rclone is single +executable (`rclone`, or `rclone.exe` on Windows) that you can download as a +zip archive and extract into a location of your choosing. When executing different +commands, it may create files in different locations, such as a configuration file +and various temporary files. By default the locations for these are according to +your operating system, e.g. configuration file in your user profile directory and +temporary files in the standard temporary directory, but you can customize all of +them, e.g. to make a completely self-contained, portable installation. + +Run the [config paths](/commands/rclone_config_paths/) command to see +the locations that rclone will use. + +To override them set the corresponding options (as command-line arguments, or as +[environment variables](https://rclone.org/docs/#environment-variables)): + - [--config](https://rclone.org/docs/#config-config-file) + - [--cache-dir](https://rclone.org/docs/#cache-dir-dir) + - [--temp-dir](https://rclone.org/docs/#temp-dir-dir) + ## Autostart After installing and configuring rclone, as described above, you are ready to use rclone