aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/connect
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2021-11-10 18:38:17 +0100
committerQuentin Dufour <quentin@deuxfleurs.fr>2021-11-10 18:38:17 +0100
commit100aad8bf4ff0c96ee604ea87db71ae424bdbe39 (patch)
treec21c42a0f6f782a0043914789e9ba8d66389c4a6 /doc/book/src/connect
parent80a87929b0c0a8dba3f80ab1b6cdb96b317f6e31 (diff)
downloadgarage-100aad8bf4ff0c96ee604ea87db71ae424bdbe39.tar.gz
garage-100aad8bf4ff0c96ee604ea87db71ae424bdbe39.zip
Add rclone mount doc
Diffstat (limited to 'doc/book/src/connect')
-rw-r--r--doc/book/src/connect/fs.md38
1 files changed, 38 insertions, 0 deletions
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 = <access key>
+secret_access_key = <secret key>
+region = <region>
+endpoint = <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