https://github.com/fclairamb/afero-s3
https://github.com/fclairamb/afero-s3
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/fclairamb/afero-s3
- Owner: fclairamb
- License: mit
- Created: 2020-05-16T22:58:23.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-15T22:15:14.000Z (about 1 year ago)
- Last Synced: 2025-03-29T03:07:03.139Z (about 1 year ago)
- Language: Go
- Size: 634 KB
- Stars: 51
- Watchers: 3
- Forks: 23
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# S3 Backend for Afero
[](https://codecov.io/gh/fclairamb/afero-s3)
[](https://goreportcard.com/report/fclairamb/afero-s3)
[](https://godoc.org/github.com/fclairamb/afero-s3)
## About
It provides an [afero filesystem](https://github.com/spf13/afero/) implementation of an [S3](https://aws.amazon.com/s3/) backend.
This was created to provide a backend to the [ftpserver](https://github.com/fclairamb/ftpserver) but can definitely be used in any other code.
I'm very opened to any improvement through issues or pull-request that might lead to a better implementation or even
better testing.
## Key points
- Download & upload file streaming
- 75% coverage (all APIs are tested, but not all errors are reproduced)
- Very carefully linted
## Known limitations
- File appending / seeking for write is not supported because S3 doesn't support it, it could be simulated by rewriting entire files.
- Chtimes is not supported because S3 doesn't support it, it could be simulated through metadata.
- Chmod support is very limited
## How to use
Note: Errors handling is skipped for brevity but you definitely have to handle it.
```golang
import(
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/session"
s3 "github.com/fclairamb/afero-s3"
)
func main() {
// You create a session
sess, _ := session.NewSession(&aws.Config{
Region: aws.String(region),
Credentials: credentials.NewStaticCredentials(keyID, secretAccessKey, ""),
})
// Initialize the file system
s3Fs := s3.NewFs(bucket, sess)
// And do your thing
file, _ := fs.OpenFile("file.txt", os.O_WRONLY, 0777)
file.WriteString("Hello world !")
file.Close()
}
```
## Thanks
The initial code (which was massively rewritten) comes from:
- [wreulicke's fork](https://github.com/wreulicke/afero-s3)
- Itself forked from [aviau's fork](https://github.com/aviau/).
- Initially proposed as [an afero PR](https://github.com/spf13/afero/pull/90) by [rgarcia](https://github.com/rgarcia) and updated by [aviau](https://github.com/aviau).