octoleo/s3fs-fuse
1
0
Fork 0
mirror of https://github.com/s3fs-fuse/s3fs-fuse.git synced 2024-12-23 01:08:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
FUSE-based file system backed by Amazon S3
532 Commits 1 Branch 23 Tags 13 MiB
C++ 85.4%
Shell 12%
M4 1%
C 0.7%
Makefile 0.6%
Other 0.3%
8e55f45818
Go to file
Jesse Steele 8e55f45818 Update README.md 
received "should not have others permissions" when mounting
did chmod 640 and received "should not have group permissions"
used chmod 600 after creating the password file and had no problems
2015-09-05 15:08:07 +08:00
doc Fixed a few small spelling issues. 2015-07-10 11:50:40 -07:00
src Added chacking cache dir perms at starting(2). 2015-08-23 04:14:57 +00:00
test Skip xattr tests if utilities are missing 2015-08-21 10:05:14 -07: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 Run cppcheck during Travis builds 2015-08-18 03:01:14 -07:00
AUTHORS Summary of Changes(1.72 -> 1.73) 2013-08-23 17:24:47 +00:00
autogen.sh s3fs can print version with short commit hash - #228 2015-08-21 16:19:31 +00:00
ChangeLog Updated ChangeLog and configure.ac for v1.79 2015-07-19 16:14:33 +00:00
configure.ac s3fs can print version with short commit hash(2) - #228 2015-08-21 16:30:24 +00: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 s3fs can print version with short commit hash - #228 2015-08-21 16:19:31 +00:00
README.md Update README.md 2015-09-05 15:08:07 +08: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

Make sure the file has proper permissions (if you get 'permissions' error when mounting) /path/to/passwd:

chmod 600 /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