Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AWS session token support #1

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,8 @@ matrix:
before_install:
- sudo add-apt-repository -y ppa:openjdk-r/ppa
- sudo apt-get update -qq
- sudo apt-get install -qq attr libfuse-dev openjdk-7-jdk
- sudo apt-get install -qq attr cppcheck libfuse-dev openjdk-7-jdk
- sudo update-alternatives --set java /usr/lib/jvm/java-7-openjdk-ppc64el/jre/bin/java
- sudo git clone --branch 1.61 https://github.com/danmar/cppcheck.git
- pwd
- cd ./cppcheck
- sudo make
- sudo make install
- cd ../
script:
- ./autogen.sh
- ./configure CPPFLAGS='-I/usr/local/opt/openssl/include' CXXFLAGS='-std=c++03'
Expand Down
51 changes: 24 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
s3fs
====
# s3fs

s3fs allows Linux and macOS to mount an S3 bucket via FUSE.
s3fs preserves the native object format for files, allowing use of other
tools like [AWS CLI](https://github.com/aws/aws-cli).
[![Build Status](https://travis-ci.org/s3fs-fuse/s3fs-fuse.svg?branch=master)](https://travis-ci.org/s3fs-fuse/s3fs-fuse)

Features
--------
## 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
Expand All @@ -20,42 +18,43 @@ Features
* user-specified regions, including Amazon GovCloud
* authenticate via v2 or v4 signatures

Installation
------------
## Installation

Many systems provide pre-built packages:

* On Debian 9 and Ubuntu 16.04 or newer:
* Amazon Linux via EPEL:

```
sudo apt-get install s3fs
sudo amazon-linux-extras install epel
sudo yum install s3fs-fuse
```

* On SUSE 12 or newer and openSUSE 42.1 or newer:
* Debian 9 and Ubuntu 16.04 or newer:

```
sudo zypper in s3fs
sudo apt-get install s3fs
```

* On Fedora 27 and newer:
* Fedora 27 or newer:

```
sudo yum install s3fs-fuse
```

* On RHEL/CentOS 7 and newer through EPEL repositories:
* RHEL and CentOS 7 or newer through via EPEL:

```
sudo yum install epel-release
sudo yum install s3fs-fuse
```

* On Amazon Linux through EPEL repositories:
* SUSE 12 and openSUSE 42.1 or newer:

```
sudo amazon-linux-extras install epel
sudo yum install s3fs-fuse
sudo zypper install s3fs
```

* On macOS, install via [Homebrew](https://brew.sh/):
* macOS via [Homebrew](https://brew.sh/):

```
brew cask install osxfuse
Expand All @@ -64,8 +63,7 @@ Many systems provide pre-built packages:

Otherwise consult the [complation instructions](COMPILATION.md).

Examples
--------
## Examples

s3fs supports the standard
[AWS credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html)
Expand Down Expand Up @@ -115,14 +113,17 @@ s3fs mybucket /path/to/mountpoint -o passwd_file=${HOME}/.passwd-s3fs -o url=htt
```

or(fstab)

```
s3fs#mybucket /path/to/mountpoint fuse _netdev,allow_other,use_path_request_style,url=https://url.to.s3/ 0 0
```

To use IBM IAM Authentication, use the `-o ibm_iam_auth` option, and specify the Service Instance ID and API Key in your credentials file:

```
echo SERVICEINSTANCEID:APIKEY > /path/to/passwd
```

The Service Instance ID is only required when using the `-o create_bucket` option.

Note: You may also want to create the global credential file first
Expand All @@ -134,9 +135,7 @@ chmod 600 /etc/passwd-s3fs

Note2: You may also need to make sure `netfs` service is start on boot


Limitations
-----------
## Limitations

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

Expand All @@ -148,23 +147,21 @@ Generally S3 cannot offer the same performance or semantics as a local file syst
* no hard links
* inotify detects only local modifications, not external ones by other clients or tools

References
----------
## References

* [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
* [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

Frequently Asked Questions
--------------------------
## Frequently Asked Questions

* [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)

License
-------
## License

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

Expand Down
Loading