aboutsummaryrefslogtreecommitdiff
path: root/content/documentation/connect/fs.md
diff options
context:
space:
mode:
authorsptaule <lecas83@gmail.com>2022-01-24 20:58:36 +0100
committersptaule <lecas83@gmail.com>2022-01-24 20:58:36 +0100
commitdc932f973593747697b98aa612a308df889741ab (patch)
treed1b88306af8373d650161e845c26690a52e32d29 /content/documentation/connect/fs.md
parent336fd3f7566c7872c17b30f7cd150e1d16899205 (diff)
downloadgaragehq.deuxfleurs.fr-dc932f973593747697b98aa612a308df889741ab.tar.gz
garagehq.deuxfleurs.fr-dc932f973593747697b98aa612a308df889741ab.zip
Added doc book
Diffstat (limited to 'content/documentation/connect/fs.md')
-rw-r--r--content/documentation/connect/fs.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/content/documentation/connect/fs.md b/content/documentation/connect/fs.md
new file mode 100644
index 0000000..be8a340
--- /dev/null
+++ b/content/documentation/connect/fs.md
@@ -0,0 +1,68 @@
+# FUSE (s3fs, goofys, s3backer...)
+
+**WARNING! Garage is not POSIX compatible.
+Mounting S3 buckets as filesystems will not provide POSIX compatibility.
+If you are not careful, you will lose or corrupt your data.**
+
+Do not use these FUSE filesystems to store any database files (eg. MySQL, Postgresql, Mongo or sqlite),
+any daemon cache (dovecot, openldap, gitea, etc.),
+and more generally any software that use locking, advanced filesystems features or make any synchronisation assumption.
+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
+
+*External link:* [s3fs github > README.md](https://github.com/s3fs-fuse/s3fs-fuse#examples)
+
+## goofys
+
+*External link:* [goofys github > README.md](https://github.com/kahing/goofys#usage)
+
+## s3backer
+
+*External link:* [s3backer github > manpage](https://github.com/archiecobbs/s3backer/wiki/ManPage)
+
+## csi-s3
+
+*External link:* [csi-s3 Github > README.md](https://github.com/ctrox/csi-s3)