github/rclone
1
Fork 0
mirror of https://github.com/rclone/rclone synced 2025-01-01 01:06:24 +01:00
Code Releases Activity

docs: add an extra paragraph with links to rclone rc and the HTTP API

Browse Source 
See: https://forum.rclone.org/t/rcd-endpoint-documenation/20949
This commit is contained in:
Nick Craig-Wood 2020-12-11 10:58:59 +00:00
parent 4f8ee736b1
commit 5ae5e1dd56
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/content/rc.md
View File

@ -5,9 +5,12 @@ description: "Remote controlling rclone with its API"
# 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. 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/). If you just want to run a remote control then see the [rcd command](/commands/rclone_rcd/).
## Supported parameters ## Supported parameters
@ -147,7 +150,7 @@ use these methods. The alternative is to use `--rc-user` and
Default Off. 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 Rclone itself implements the remote control protocol in its `rclone
rc` command. rc` command.
@ -1377,7 +1380,7 @@ must be supplied.
{{< rem autogenerated stop >}} {{< rem autogenerated stop >}}
## Accessing the remote control via HTTP ## Accessing the remote control via HTTP {#api-http}
Rclone implements a simple HTTP based protocol. Rclone implements a simple HTTP based protocol.