added readme
This commit is contained in:
parent
3fab4d1717
commit
1b64366283
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,3 +1,2 @@
|
||||
.env
|
||||
.vscode
|
||||
readme.md
|
||||
|
40
readme.md
Normal file
40
readme.md
Normal file
@ -0,0 +1,40 @@
|
||||
# Easy 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).
|
Loading…
Reference in New Issue
Block a user