From 3ba57cabce0edb16c578f595099acffb2a56c6d8 Mon Sep 17 00:00:00 2001 From: static-moonlight <107991124+static-moonlight@users.noreply.github.com> Date: Sat, 13 Apr 2024 10:24:38 +0200 Subject: [PATCH] doc: add example how to run serve s3 --- cmd/serve/s3/serve_s3.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/cmd/serve/s3/serve_s3.md b/cmd/serve/s3/serve_s3.md index 65445ff1c..a7cda6232 100644 --- a/cmd/serve/s3/serve_s3.md +++ b/cmd/serve/s3/serve_s3.md @@ -37,7 +37,27 @@ like this: rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path ``` -This will be compatible with an rclone remote which is defined like this: +For example, to use a simple folder in the filesystem, run the server +with a command like this: + +``` +rclone serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY local:/path/to/folder +``` + +The `rclone.conf` for the server could look like this: + +``` +[local] +type = local +``` + +The `local` configuration is optional though. If you run the server with a +`remote:path` like `/path/to/folder` (without the `local:` prefix and without an +`rclone.conf` file), rclone will fall back to a default configuration, which +will be visible as a warning in the logs. But it will run nonetheless. + +This will be compatible with an rclone (client) remote configuration which +is defined like this: ``` [serves3]