octoleo/s3fs-fuse
1
0
Fork 0
mirror of https://github.com/s3fs-fuse/s3fs-fuse.git synced 2024-06-01 08:30:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
FUSE-based file system backed by Amazon S3
492 Commits 1 Branch 22 Tags 11 MiB
C++ 85.5%
Shell 11.9%
M4 1%
C 0.7%
Makefile 0.6%
Other 0.3%
20f425fe15
Go to file
Andrew Gaul 20f425fe15 Update README 
This better explains many of the features and limitations and removes
stale information.
2015-08-17 07:48:11 -07:00
doc Fixed a few small spelling issues. 2015-07-10 11:50:40 -07:00
src Configure cppcheck #224 2015-08-12 15:04:16 +00:00
test Convert rename_before_close to a shell script #229 2015-08-12 15:09:34 +00:00
.gitignore Update .gitignore 2015-04-27 11:19:14 -07:00
.mailmap Add .mailmap 2015-04-27 11:17:39 -07:00
.travis.yml Disasble integration tests for Travis 2015-06-18 11:28:10 -07:00
AUTHORS Summary of Changes(1.72 -> 1.73) 2013-08-23 17:24:47 +00:00
autogen.sh In preparation to remove the unnecessary "s3fs" 2010-11-13 23:59:23 +00:00
ChangeLog Updated ChangeLog and configure.ac for v1.79 2015-07-19 16:14:33 +00:00
configure.ac Update README 2015-08-17 07:48:11 -07:00
COPYING In preparation to remove the unnecessary "s3fs" 2010-11-13 23:59:23 +00:00
INSTALL In preparation to remove the unnecessary "s3fs" 2010-11-13 23:59:23 +00:00
Makefile.am Configure cppcheck #224 2015-08-12 15:04:16 +00:00
README.md Update README 2015-08-17 07:48:11 -07:00

README.md

s3fs

s3fs allows Linux and Mac OS X to mount an S3 bucket via FUSE. s3fs preserves the native object format for files, allowing use of other tools like s3cmd.

Features

  • large subset of POSIX including reading/writing files, directories, symlinks, mode, uid/gid, and extended attributes
  • compatible with Amazon S3, Google Cloud Storage, and other S3-based object stores
  • 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

Installation

Ensure you have all the dependencies:

On Ubuntu 14.04:

sudo apt-get install automake autotools-dev g++ git libcurl4-gnutls-dev libfuse-dev libssl-dev libxml2-dev make pkg-config

On CentOS 7:

sudo yum install automake fuse-devel gcc-c++ git libcurl-devel libxml2-devel make openssl-devel

Compile from master via the following commands:

git clone https://github.com/s3fs-fuse/s3fs-fuse.git
cd s3fs-fuse
./autogen.sh
./configure
make
sudo make install

Examples

Enter your S3 identity and credential in a file /path/to/passwd:

echo MYIDENTITY:MYCREDENTIAL > /path/to/passwd

Run s3fs with an existing bucket mybucket and directory /path/to/mountpoint:

s3fs mybucket /path/to/mountpoint -o passwd_file=/path/to/passwd

If you encounter any errors, enable debug output:

s3fs mybucket /path/to/mountpoint -o passwd_file=/path/to/passwd -d -d -f -o f2 -o curldbg

You can also automatically mount via fstab:

s3fs#mybucket /path/to/mountpoint fuse allow_other 0 0

Limitations

Generally S3 cannot offer the same performance or semantics as a local file system. More specifically:

  • random writes or appends to files require rewriting the entire file
  • metadata operations such as listing directories have poor performance due to network latency
  • eventual consistency can temporarily yield stale data
  • no coordination between multiple clients mounting the same bucket
  • no hard links

References

  • s3backer - mount an S3 bucket as a single file
  • s3fs-python - an older and less complete implementation written in Python
  • S3Proxy - combine with s3fs to mount EMC Atmos, Microsoft Azure, and OpenStack Swift buckets
  • s3ql - similar to s3fs but uses its own object format
  • YAS3FS - similar to s3fs but uses SNS to allow multiple clients to mount a bucket

License

Copyright (C) 2010 Randy Rizun rrizun@gmail.com

Licensed under the GNU GPL version 2