s3 serve: Improve documentation: instructions unclear

[static-moonlight]

s3 serve: Improve documentation: instructions unclear

[static-moonlight]

I think this can be closed

[albertony]

As far as I understand the documentation, the example config is for the client side?

I think you are correct.

podman run --rm docker.io/rclone/rclone:1.66 serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY remote:path

You need to supply the path that you want to serve, using syntax from https://rclone.org/docs/#syntax-of-remote-paths. If you want to serve something from local disk, then specify path to it:

podman run --rm docker.io/rclone/rclone:1.66 serve s3 --auth-key ACCESS_KEY_ID,SECRET_ACCESS_KEY /path/to/serve

[static-moonlight]

Thanks. I wish the documentation would provide that as an example.

[ncw]

It might be an idea to have both examples as /path/to/wherever shows it works for local files but remote:path shows it works for remote things which is kind of rclone's special sauce.

@static-moonlight The documentation is here https://github.com/rclone/rclone/blob/master/cmd/serve/s3/serve_s3.md - you can click the pencil icon to suggest a change.