YunoHost-Apps / minio_ynh

High Performance, Kubernetes Native Object Storage, packaged for YunoHost
https://min.io
GNU Affero General Public License v3.0
8 stars 4 forks source link

Disclaimer is confusing #20

Open ericgaspar opened 2 years ago

ericgaspar commented 2 years ago

I am testing Minio in order to evaluate if it can be used with BookStack_ynh...

I find the explanations in the disclaimer confusing. Those explanation are intended for app developpers and not regular user. A more indepth tutorial on how to integrate this app with others and how to use it (how to use Minio client) will be a plus.

For Bookstack, I will need to set up those Minio variables...

STORAGE_TYPE=s3
STORAGE_S3_KEY=your-service-key
STORAGE_S3_SECRET=your-service-secret-key
STORAGE_S3_BUCKET=your-service-bucket-name

STORAGE_S3_ENDPOINT=https://your-service-base-endpoint.com:8080
STORAGE_URL=https://your-service-base-endpoint.com:8080/your-service-bucket-name
Limezy commented 2 years ago

Hi @ericgaspar many thanks for your notice.

I see MinIO as a "tech brick" which is indeed not meant to be used by the regular user. Actually, I guess that the regular user should never install MinIO directly. MinIO should always be installed and setup for him by another "real" app (such as Bookstack or Outline), using the mechanism I have been using for Outline :

1. IF MinIO app is not installed THEN install MinIO app
2. Retrieve MinIO credentials
3. Use MinIO command line client to setup a new bucket with the correct name, permissions etc... 
4. Setup the S3 config of app being installed accordingly

The disclaimer is meant to help app packagers to script the steps 2 and 3, but it's true that it may not be the right place. Shall I write it on the Yunohost website instead ?

For your use case here, let me try to make a PR for you