diff options
author | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
---|---|---|
committer | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
commit | 1c0ba930b8d6aa5d97e6942852240861e6ab9bed (patch) | |
tree | cddc9af5fc2378c76fe5ef6306f807e27648b7a7 /doc/book/src/connect/fs.md | |
parent | 45d6d377d2011d8fb4ceb13bb4584df97c458525 (diff) | |
download | garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.tar.gz garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.zip |
Reorganize documentation for new website (#213)
This PR should be merged after the new website is deployed.
- [x] Rename files
- [x] Add front matter section to all `.md` files in the book (necessary for Zola)
- [x] Change all internal links to use Zola's linking system that checks broken links
- [x] Some updates to documentation contents and organization
Co-authored-by: Alex Auvolat <alex@adnab.me>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/213
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>
Diffstat (limited to 'doc/book/src/connect/fs.md')
-rw-r--r-- | doc/book/src/connect/fs.md | 68 |
1 files changed, 0 insertions, 68 deletions
diff --git a/doc/book/src/connect/fs.md b/doc/book/src/connect/fs.md deleted file mode 100644 index be8a3402..00000000 --- a/doc/book/src/connect/fs.md +++ /dev/null @@ -1,68 +0,0 @@ -# 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) |