https://github.com/jkaninda/s3fs

AWS S3 client, Object Storage client , MinIO Object Storage client
https://github.com/jkaninda/s3fs

aws-s3 minio object-storage s3 s3-client

Last synced: 10 days ago
JSON representation

AWS S3 client, Object Storage client , MinIO Object Storage client

• Host: GitHub
• URL: https://github.com/jkaninda/s3fs
• Owner: jkaninda
• License: mit
• Created: 2022-12-28T17:50:01.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-25T13:43:11.000Z (9 months ago)
• Last Synced: 2024-06-21T18:52:45.132Z (5 months ago)
• Topics: aws-s3, minio, object-storage, s3, s3-client
• Language: Go
• Homepage:
• Size: 26.4 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# s3fs

 🐳 AWS S3 client, Object Storage client  

[![Build](https://github.com/jkaninda/s3fs/actions/workflows/build.yml/badge.svg)](https://github.com/jkaninda/mysql-bkup/actions/workflows/build.yml)

[![Go Report](https://goreportcard.com/badge/github.com/jkaninda/s3fs)](https://goreportcard.com/report/github.com/jkaninda/s3fs)

![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/jkaninda/s3fs?style=flat-square)

![Docker Pulls](https://img.shields.io/docker/pulls/jkaninda/s3fs?style=flat-square)

> Path:

AWS S3 Storage mounting path: `/s3mnt`

## Supported

- AWS S3

- MinIO

- And all AWS S3 alternative object storage solution

## Simple docker compose usage:

```yaml

version: '3.7'

services:

 s3fs:

  container_name: s3fs

  image: jkaninda/s3fs

  privileged: true

  devices:

    - "/dev/fuse"

  environment:

   - ACCESS_KEY=${ACCESS_KEY}

   - SECRET_KEY=${SECRET_KEY}

   - BUCKET_NAME=${BUCKET_NAME}

   - S3_ENDPOINT=${S3_ENDPOINT}

```

## Copy a file to S3

This is a simple example of copying a file from your local storage to S3, and after the copy container will stop running.

To keep the container running you need add `--keep` flag.

`s3fsc mount --keep`

```yaml

version: '3.7'

services:

 s3fs:

  container_name: s3fs

  image: jkaninda/s3fs

  privileged: true

  volumes:

    - ./backup/:/backup

  devices:

    - "/dev/fuse"

    ## Mount S3 Storage and copy a file

  command:

   - /bin/sh

   - -c

   - |

     s3fsc mount 

    cp /backup/my_file.gz /s3mnt/my_file.gz 

  environment:

   - ACCESS_KEY=${ACCESS_KEY}

   - SECRET_KEY=${SECRET_KEY}

   - BUCKET_NAME=${BUCKET_NAME}

   - S3_ENDPOINT=${S3_ENDPOINT}

```

> P.S. please give a star if you like it :wink: