From 5ae5e1dd561fbd6291acb062eced72fee9159d4a Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Fri, 11 Dec 2020 10:58:59 +0000 Subject: [PATCH] docs: add an extra paragraph with links to rclone rc and the HTTP API See: https://forum.rclone.org/t/rcd-endpoint-documenation/20949 --- docs/content/rc.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/content/rc.md b/docs/content/rc.md index 69b262184..537e0dfd9 100644 --- a/docs/content/rc.md +++ b/docs/content/rc.md @@ -5,9 +5,12 @@ description: "Remote controlling rclone with its API" # Remote controlling rclone with its API -If rclone is run with the `--rc` flag then it starts an http server +If rclone is run with the `--rc` flag then it starts an HTTP server which can be used to remote control rclone using its API. +You can either use the [rclone rc](#api-rc) command to access the API +or [use HTTP directly](#api-http). + If you just want to run a remote control then see the [rcd command](/commands/rclone_rcd/). ## Supported parameters @@ -147,7 +150,7 @@ use these methods. The alternative is to use `--rc-user` and Default Off. -## Accessing the remote control via the rclone rc command +## Accessing the remote control via the rclone rc command {#api-rc} Rclone itself implements the remote control protocol in its `rclone rc` command. @@ -1377,7 +1380,7 @@ must be supplied. {{< rem autogenerated stop >}} -## Accessing the remote control via HTTP +## Accessing the remote control via HTTP {#api-http} Rclone implements a simple HTTP based protocol.