From 351622cfabdf448b0a67ac1b5737a24d7063ea06 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 29 Mar 2024 07:13:21 +0100 Subject: [PATCH] Auto-update README --- ALL_README.md | 6 +++++ README.md | 24 ++++++++--------- README_fr.md | 30 ++++++++++----------- README_gl.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++ README_it.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 183 insertions(+), 27 deletions(-) create mode 100644 ALL_README.md create mode 100644 README_gl.md create mode 100644 README_it.md diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..3d6c579 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [Leggi il “README” in italiano](README_it.md) diff --git a/README.md b/README.md index ed25cf8..c6902a4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install MinIO server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=minio) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install MinIO server quickly and simply on a YunoHost server. -If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* +> *This package allows you to install MinIO server quickly and simply on a YunoHost server.* +> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.* ## Overview @@ -54,19 +54,19 @@ popd ## Documentation and resources -* Official app website: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official admin documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/minio_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/minio_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/minio_ynh/tree/testing --debug or sudo yunohost app upgrade minio -u https://github.com/YunoHost-Apps/minio_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index 4a9bf18..38aeb64 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # MinIO server pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer MinIO server avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=minio) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer MinIO server rapidement et simplement sur un serveur YunoHost. -Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* +> *Ce package vous permet d’installer MinIO server rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -46,7 +46,7 @@ pushd "$mc_path" popd ``` -**Version incluse :** 2023.09.07~ynh1 +**Version incluse :** 2023.09.07~ynh1 ## Captures d’écran @@ -54,22 +54,22 @@ popd ## Documentations et ressources -* Site officiel de l’app : -* Documentation officielle de l’admin : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/minio_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/minio_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/minio_ynh/tree/testing --debug ou sudo yunohost app upgrade minio -u https://github.com/YunoHost-Apps/minio_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..669c0da --- /dev/null +++ b/README_gl.md @@ -0,0 +1,75 @@ + + +# MinIO server para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/minio.svg)](https://dash.yunohost.org/appci/app/minio) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/minio.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/minio.maintain.svg) + +[![Instalar MinIO server con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=minio) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar MinIO server de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +MinIO is a High Performance Object Storage released under GNU Affero General Public License v3.0. It is API compatible with Amazon S3 cloud storage service. Use MinIO to build high performance infrastructure for machine learning, analytics and application data workloads. + +## How to create a Yunohost app using MinIO +During the install process, MinIO will install both the MinIO server and MinIO client. +If your app needs to use an Amazon S3 storage, I recommend to use the MinIO client to create and setup buckets as per your app's requirements. You can have a look at outline_ynh app for reference. + +### First step: retrieve MinIO credentials +``` +#================================================= +# SETUP MINIO CREDENTIALS +#================================================= +minio_domain=$(ynh_app_setting_get --app="minio" --key=domain) +minio_admin=$(ynh_app_setting_get --app="minio" --key=admin) +minio_password=$(ynh_app_setting_get --app="minio" --key=password) +mc_path=$(ynh_app_setting_get --app="minio" --key=mc_path) +``` + +### Second step: create and setup your bucket +``` +#================================================= +# SETUP MINIO BUCKET +#================================================= +ynh_script_progression --message="Setting up MinIO bucket for YOURAPP..." --weight=1 + +pushd "$mc_path" + ynh_exec_warn_less sudo -u minio ./mc mb minio/NAME_OF_YOUR_BUCKET --region "NAME_OF_YOUR_REGION" + ynh_exec_warn_less sudo -u minio ./mc policy set NEEDED_POLICY minio/NAME_OF_YOUR_BUCKET +popd +``` + +**Versión proporcionada:** 2023.09.07~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de MinIO server](./doc/screenshots/minio-browser.png) + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para admin: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/minio_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/minio_ynh/tree/testing --debug +ou +sudo yunohost app upgrade minio -u https://github.com/YunoHost-Apps/minio_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_it.md b/README_it.md new file mode 100644 index 0000000..7f2c025 --- /dev/null +++ b/README_it.md @@ -0,0 +1,75 @@ + + +# MinIO server per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/minio.svg)](https://dash.yunohost.org/appci/app/minio) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/minio.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/minio.maintain.svg) + +[![Installa MinIO server con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=minio) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare MinIO server su un server YunoHost in modo semplice e veloce.* +> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* + +## Panoramica + +MinIO is a High Performance Object Storage released under GNU Affero General Public License v3.0. It is API compatible with Amazon S3 cloud storage service. Use MinIO to build high performance infrastructure for machine learning, analytics and application data workloads. + +## How to create a Yunohost app using MinIO +During the install process, MinIO will install both the MinIO server and MinIO client. +If your app needs to use an Amazon S3 storage, I recommend to use the MinIO client to create and setup buckets as per your app's requirements. You can have a look at outline_ynh app for reference. + +### First step: retrieve MinIO credentials +``` +#================================================= +# SETUP MINIO CREDENTIALS +#================================================= +minio_domain=$(ynh_app_setting_get --app="minio" --key=domain) +minio_admin=$(ynh_app_setting_get --app="minio" --key=admin) +minio_password=$(ynh_app_setting_get --app="minio" --key=password) +mc_path=$(ynh_app_setting_get --app="minio" --key=mc_path) +``` + +### Second step: create and setup your bucket +``` +#================================================= +# SETUP MINIO BUCKET +#================================================= +ynh_script_progression --message="Setting up MinIO bucket for YOURAPP..." --weight=1 + +pushd "$mc_path" + ynh_exec_warn_less sudo -u minio ./mc mb minio/NAME_OF_YOUR_BUCKET --region "NAME_OF_YOUR_REGION" + ynh_exec_warn_less sudo -u minio ./mc policy set NEEDED_POLICY minio/NAME_OF_YOUR_BUCKET +popd +``` + +**Versione pubblicata:** 2023.09.07~ynh1 + +## Screenshot + +![Screenshot di MinIO server](./doc/screenshots/minio-browser.png) + +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Documentazione ufficiale per gli amministratori: +- Repository upstream del codice dell’app: +- Store di YunoHost: +- Segnala un problema: + +## Informazioni per sviluppatori + +Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/minio_ynh/tree/testing). + +Per provare la branch di `testing`, si prega di procedere in questo modo: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/minio_ynh/tree/testing --debug +o +sudo yunohost app upgrade minio -u https://github.com/YunoHost-Apps/minio_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**