s3fs-fuse/README.md

186 lines
5.9 KiB
Markdown
Raw Normal View History

2019-04-14 07:11:51 +00:00
# s3fs
2023-03-05 06:03:48 +00:00
s3fs allows Linux, macOS, and FreeBSD to mount an S3 bucket via [FUSE(Filesystem in Userspace)](https://github.com/libfuse/libfuse).
s3fs makes you operate files and directories in S3 bucket like a local file system.
s3fs preserves the native object format for files, allowing use of other tools like [AWS CLI](https://github.com/aws/aws-cli).
[![s3fs-fuse CI](https://github.com/s3fs-fuse/s3fs-fuse/actions/workflows/ci.yml/badge.svg)](https://github.com/s3fs-fuse/s3fs-fuse/actions/workflows/ci.yml)
2020-02-07 00:01:50 +00:00
[![Twitter Follow](https://img.shields.io/twitter/follow/s3fsfuse.svg?style=social&label=Follow)](https://twitter.com/s3fsfuse)
![s3fs-fuse](https://github.com/ggtakec/s3fs-fuse-images/blob/master/images/s3fslogo.png)
2019-04-14 07:11:51 +00:00
## Features
* large subset of POSIX including reading/writing files, directories, symlinks, mode, uid/gid, and extended attributes
2020-08-12 14:04:49 +00:00
* compatible with Amazon S3, and other [S3-based object stores](https://github.com/s3fs-fuse/s3fs-fuse/wiki/Non-Amazon-S3)
* allows random writes and appends
* large files via multi-part upload
* renames via server-side copy
* optional server-side encryption
* data integrity via MD5 hashes
* in-memory metadata caching
* local disk data caching
* user-specified regions, including Amazon GovCloud
* authenticate via v2 or v4 signatures
2019-04-14 07:11:51 +00:00
## Installation
Many systems provide pre-built packages:
* Amazon Linux via EPEL:
```
sudo amazon-linux-extras install epel
sudo yum install s3fs-fuse
```
* Arch Linux:
```
sudo pacman -S s3fs-fuse
```
* Debian 9 and Ubuntu 16.04 or newer:
```
sudo apt install s3fs
```
* Fedora 27 or newer:
```
sudo dnf install s3fs-fuse
```
2019-11-04 16:08:57 +00:00
* Gentoo:
```
sudo emerge net-fs/s3fs
```
2021-07-22 04:54:20 +00:00
* RHEL and CentOS 7 or newer via EPEL:
```
sudo yum install epel-release
sudo yum install s3fs-fuse
```
* SUSE 12 and openSUSE 42.1 or newer:
2019-03-09 13:24:27 +00:00
```
sudo zypper install s3fs
2019-03-09 13:24:27 +00:00
```
* macOS 10.12 and newer via [Homebrew](https://brew.sh/):
```
2022-12-06 11:49:50 +00:00
brew install --cask macfuse
2021-12-13 11:14:21 +00:00
brew install gromgit/fuse/s3fs-mac
```
* FreeBSD:
```
pkg install fusefs-s3fs
```
2023-03-05 06:03:48 +00:00
* Windows:
Windows has its own install, seening in [this link](COMPILATION.md)
Otherwise consult the [compilation instructions](COMPILATION.md).
2019-04-14 07:11:51 +00:00
## Examples
s3fs supports the standard
[AWS credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html)
stored in `${HOME}/.aws/credentials`. Alternatively, s3fs supports a custom passwd file.
2023-09-19 22:26:45 +00:00
Finally s3fs recognizes the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_SESSION_TOKEN`
environment variables.
The default location for the s3fs password file can be created:
2020-08-02 14:01:03 +00:00
* using a `.passwd-s3fs` file in the users home directory (i.e. `${HOME}/.passwd-s3fs`)
* using the system-wide `/etc/passwd-s3fs` file
Enter your credentials in a file `${HOME}/.passwd-s3fs` and set
2017-09-13 01:44:17 +00:00
owner-only permissions:
```
echo ACCESS_KEY_ID:SECRET_ACCESS_KEY > ${HOME}/.passwd-s3fs
chmod 600 ${HOME}/.passwd-s3fs
```
Run s3fs with an existing bucket `mybucket` and directory `/path/to/mountpoint`:
```
s3fs mybucket /path/to/mountpoint -o passwd_file=${HOME}/.passwd-s3fs
```
If you encounter any errors, enable debug output:
```
s3fs mybucket /path/to/mountpoint -o passwd_file=${HOME}/.passwd-s3fs -o dbglevel=info -f -o curldbg
```
You can also mount on boot by entering the following line to `/etc/fstab`:
```
mybucket /path/to/mountpoint fuse.s3fs _netdev,allow_other 0 0
2017-09-13 01:44:17 +00:00
```
2016-01-24 05:34:28 +00:00
2017-11-19 07:03:39 +00:00
If you use s3fs with a non-Amazon S3 implementation, specify the URL and path-style requests:
```
s3fs mybucket /path/to/mountpoint -o passwd_file=${HOME}/.passwd-s3fs -o url=https://url.to.s3/ -o use_path_request_style
2017-11-19 07:03:39 +00:00
```
or(fstab)
2019-04-14 07:11:51 +00:00
2017-11-19 07:03:39 +00:00
```
mybucket /path/to/mountpoint fuse.s3fs _netdev,allow_other,use_path_request_style,url=https://url.to.s3/ 0 0
2017-11-19 07:03:39 +00:00
```
2016-01-19 04:22:55 +00:00
Note: You may also want to create the global credential file first
```
echo ACCESS_KEY_ID:SECRET_ACCESS_KEY > /etc/passwd-s3fs
2016-07-14 15:55:03 +00:00
chmod 600 /etc/passwd-s3fs
2016-01-19 04:22:55 +00:00
```
2016-01-19 05:06:10 +00:00
Note2: You may also need to make sure `netfs` service is start on boot
2019-04-14 07:11:51 +00:00
## Limitations
Generally S3 cannot offer the same performance or semantics as a local file system. More specifically:
2020-05-04 23:12:04 +00:00
* random writes or appends to files require rewriting the entire object, optimized with multi-part upload copy
* metadata operations such as listing directories have poor performance due to network latency
* non-AWS providers may have [eventual consistency](https://en.wikipedia.org/wiki/Eventual_consistency) so reads can temporarily yield stale data (AWS offers read-after-write consistency [since Dec 2020](https://aws.amazon.com/about-aws/whats-new/2020/12/amazon-s3-now-delivers-strong-read-after-write-consistency-automatically-for-all-applications/))
2015-09-01 20:09:44 +00:00
* no atomic renames of files or directories
* no coordination between multiple clients mounting the same bucket
* no hard links
* inotify detects only local modifications, not external ones by other clients or tools
2019-04-14 07:11:51 +00:00
## References
2022-06-28 13:56:12 +00:00
* [CSI for S3](https://github.com/ctrox/csi-s3) - Kubernetes CSI driver
2022-03-21 11:44:07 +00:00
* [docker-s3fs-client](https://github.com/efrecon/docker-s3fs-client) - Docker image containing s3fs
2016-01-08 00:13:59 +00:00
* [goofys](https://github.com/kahing/goofys) - similar to s3fs but has better performance and less POSIX compatibility
* [s3backer](https://github.com/archiecobbs/s3backer) - mount an S3 bucket as a single file
* [S3Proxy](https://github.com/gaul/s3proxy) - combine with s3fs to mount Backblaze B2, EMC Atmos, Microsoft Azure, and OpenStack Swift buckets
2019-02-05 05:03:46 +00:00
* [s3ql](https://github.com/s3ql/s3ql/) - similar to s3fs but uses its own object format
* [YAS3FS](https://github.com/danilop/yas3fs) - similar to s3fs but uses SNS to allow multiple clients to mount a bucket
2019-04-14 07:11:51 +00:00
## Frequently Asked Questions
2016-01-19 04:22:55 +00:00
* [FAQ wiki page](https://github.com/s3fs-fuse/s3fs-fuse/wiki/FAQ)
* [s3fs on Stack Overflow](https://stackoverflow.com/questions/tagged/s3fs)
* [s3fs on Server Fault](https://serverfault.com/questions/tagged/s3fs)
2015-11-26 12:31:03 +00:00
2019-04-14 07:11:51 +00:00
## License
Copyright (C) 2010 Randy Rizun <rrizun@gmail.com>
Licensed under the GNU GPL version 2