From 100aad8bf4ff0c96ee604ea87db71ae424bdbe39 Mon Sep 17 00:00:00 2001 From: Quentin Dufour Date: Wed, 10 Nov 2021 18:38:17 +0100 Subject: Add rclone mount doc --- doc/book/src/connect/fs.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) (limited to 'doc') diff --git a/doc/book/src/connect/fs.md b/doc/book/src/connect/fs.md index db486233..be8a3402 100644 --- a/doc/book/src/connect/fs.md +++ b/doc/book/src/connect/fs.md @@ -11,6 +11,44 @@ Ideally, avoid these solutions at all for any serious or production use. ## rclone mount +rclone uses the same configuration when used [in CLI](/connect/cli.html) and mount mode. +We suppose you have the following entry in your `rclone.ini` (mine is located in `~/.config/rclone/rclone.conf`): + +```toml +[garage] +type = s3 +provider = Other +env_auth = false +access_key_id = +secret_access_key = +region = +endpoint = +force_path_style = true +acl = private +bucket_acl = private +``` + +Then you can mount and access any bucket as follow: + +```bash +# mount the bucket +mkdir /tmp/my-bucket +rclone mount --daemon garage:my-bucket /tmp/my-bucket + +# set your working directory to the bucket +cd /tmp/my-bucket + +# create a file +echo hello world > hello.txt + +# access the file +cat hello.txt + +# unmount the bucket +cd +fusermount -u /tmp/my-bucket +``` + *External link:* [rclone documentation > rclone mount](https://rclone.org/commands/rclone_mount/) ## s3fs -- cgit v1.2.3