MinIO-Share-S3/readme.md
Alex Borisov f42e9b381c
All checks were successful
Actions Build Binary / Build-Binary (push) Successful in 5s
Actions Build Binary / Build-Docker-Image (push) Successful in 13s
v1-testing (#1)
Simple way to share your objects from MinIO

Reviewed-on: #1
Co-authored-by: Alex Borisov <79996669747@ya.ru>
Co-committed-by: Alex Borisov <79996669747@ya.ru>
2024-02-01 22:32:40 +03:00

41 lines
1.5 KiB
Markdown

# MinIO Share S3
MinIO Share S3 is a project that enables users to embed links to objects in MinIO and easily share them with others.
## Features
- **Object Embedding**: Users can generate embeddable links for objects stored in MinIO.
- **Easy Sharing**: The generated links can be easily shared with others, allowing them to access the objects.
- **Access Control**: Users can control the access permissions for the shared objects, ensuring data security using MinIO polices.
- **Simplified Workflow**: MinIO Share S3 provides a simple usage to share all your files in bucket
## Installation
To install MinIO Share S3, follow these steps:
1. Clone the repository: `git clone https://soaska.ru/soaska/minio-share-s3.git`
2. Install the required dependencies: `go mod download`
3. Configure the MinIO connection settings in the `.env` file.
4. Start the application: `go run`
You also can download precompiled binary from packages or set up docker container using `soaska.ru/soaska/minio-share-s3:master` image.
## Usage
Once the application is running, you can perform the following actions:
1. Upload objects to MinIO.
2. Generate access key and set up polices.
3. Set up MinIO Share S3.
4. Share links!
All environment variables are described in `sample.env` file.
## Contributing
Contributions are welcome! If you would like to contribute to MinIO Share S3, please open issue.
## License
MinIO Share S3 is licensed under the [MIT License](https://opensource.org/licenses/MIT).