From 8ffe293213a0b5f8ba6c6a6a9669ab9bfdd1573e Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Fri, 31 Dec 2021 00:35:53 +0000 Subject: [PATCH] Auto-update README --- README.md | 66 ++++++++++++++++++++++-------------------- README_fr.md | 81 +++++++++++++++++++++++++++------------------------- 2 files changed, 77 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 4bd7c81..d5a024c 100644 --- a/README.md +++ b/README.md @@ -3,65 +3,69 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app It shall NOT be edited by hand. --> -# Armadietto package for Yunohost - -[![Integration level](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/armadietto.maintain.svg) +# Armadietto for YunoHost +[![Integration level](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/armadietto.maintain.svg) [![Install Armadietto with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=armadietto) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install example quickly and simply on a YunoHost server. +> *This package allows you to install Armadietto 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.* -## Armadietto overview +## Overview -[Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js. +## TODO -Armadietto is maintained by remoteStorage Team [IRC](https://kiwiirc.com/client/irc.freenode.net/#remotestorage) +Une description longue de ce que fait l'application + +### Features + +- liste des caractéristiques... + + +**Shipped version:** 0.0.2-beta.10~ynh3 -> ### :warning: WARNING -> Please do not consider `armadietto` production ready, this project is still -> considered experimental. As with any alpha-stage storage technology, you -> MUST expect that it will eat your data and take precautions against this. You -> SHOULD expect that its APIs and storage schemas will change before it is -> labelled stable. -**Shipped version:** 0.1.5 ## Screenshots - - ![](./doc/screenshots/armadietto.png) - - - +![](./doc/screenshots/armadietto.png) ## Disclaimers / important information -### Important Notes -RemoteStorage requires a dedicated domain, so obtain one and add it using the YunoHost admin panel. **Domains -> Add domain**. As RemoteStorage uses the full domain and is installed on the root, you can create a subdomain such as remote.domain.tld. Don't forget to update your DNS if you manage them manually. +## TODO -RemoteStorage requires browser-approved SSL certificates. If you have certificates not issued by [Let's Encrypt](https://letsencrypt.org/), install them manually as usual. - - -### Application for remoteStorage -[Click here](https://remotestorage.io/apps/) to see the list of applications that can be used with RemoteStorage. +* Toute limitation ou contrainte connue ou tout élément ne fonctionnant pas, tel que (mais non limité à) : + * nécessitant un domaine dédié complet ? + * architectures non prises en charge ? + * L'authentification unique ou l'intégration LDAP ne fonctionnent pas ? + * l'application nécessite une quantité importante de RAM / disque / ... pour s'installer ou fonctionner correctement. + * etc... +* D'autres informations que les gens devraient connaître, comme.. : + * toute étape spécifique à effectuer après l'installation (comme terminer manuellement l'installation, des identifiants d'administration spécifiques, ...) + * Comment configurer / administrer l'application si ce n'est pas évident. + * le processus de mise à niveau, les spécificités, les choses à savoir ? + * Considérations de sécurité +Traduit avec www.DeepL.com/Translator (version gratuite) ## Documentation and resources * Official app website: https://remotestorage.io/ -* Upstream app code repository: https://github.com/remotestorage/armadietto/ -* Report a bug: https://github.com/bencharp/armadietto_ynh/issues +* Upstream app code repository: https://github.com/remotestorage/armadietto +* YunoHost documentation for this app: https://yunohost.org/app_armadietto +* Report a bug: https://github.com/YunoHost-Apps/armadietto_ynh/issues ## Developer info -Please send your pull request to the [testing branch](https://github.com/bencharp/armadietto_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/bencharp/armadietto_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug or -sudo yunohost app upgrade armadietto_ynh -u https://github.com/bencharp/armadietto_ynh/tree/testing --debug +sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 38aef6f..917c26a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,64 +1,67 @@ -# Armadietto package pour Yunohost +# Armadietto pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/armadietto.maintain.svg) - -[![Install Armadietto with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=armadietto) +[![Niveau d'intégration](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/armadietto.maintain.svg) +[![Installer Armadietto avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=armadietto) *[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Armadietto 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.* + +## Vue d'ensemble + +## TODO + +Une description longue de ce que fait l'application + +### Features + +- liste des caractéristiques... -> *Ce paquetage vous permet d'installer Armadietto rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, veuillez consulter [le guide](https://yunohost.org/#/install) pour savoir comment l'installer.* +**Version incluse :** 0.0.2-beta.10~ynh3 -## Aperçu d'Armadietto - -[Armadietto](https://github.com/remotestorage/armadietto/) est un serveur [remoteStorage](https://remotestorage.io) écrit pour Node.js. - -Armadietto est maintenu par l'équipe remoteStorage [IRC](https://kiwiirc.com/client/irc.freenode.net/#remotestorage). - -> ### :warning : WARNING -> Veuillez ne pas considérer `armadietto` comme prêt pour la production, ce projet est toujours -> comme expérimental. Comme avec toute technologie de stockage en phase alpha, vous -> devez vous attendre à ce qu'elle mange vos données et prendre des précautions contre cela. Vous -> Vous devez vous attendre à ce que ses API et ses schémas de stockage changent avant qu'il ne soit -> étiqueté comme stable. - -**Version livrée:** 0.1.5 ## Captures d'écran - - ![](./doc/screenshots/armadietto.png) - - - +![](./doc/screenshots/armadietto.png) ## Avertissements / informations importantes -### Notes importantes -RemoteStorage nécessite un domaine dédié, il faut donc en obtenir un et l'ajouter en utilisant le panneau d'administration de YunoHost. **Domaines -> Ajouter un domaine**. Comme RemoteStorage utilise le domaine complet et est installé à la racine, vous pouvez créer un sous-domaine tel que remote.domain.tld. N'oubliez pas de mettre à jour vos DNS si vous les gérez manuellement. +## TODO -RemoteStorage nécessite des certificats SSL approuvés par le navigateur. Si vous disposez de certificats qui ne sont pas émis par [Let's Encrypt](https://letsencrypt.org/), installez-les manuellement comme d'habitude. - - -### Application pour remoteStorage -[Cliquez ici](https://remotestorage.io/apps/) pour voir la liste des applications qui peuvent être utilisées avec RemoteStorage. +* Toute limitation ou contrainte connue ou tout élément ne fonctionnant pas, tel que (mais non limité à) : + * nécessitant un domaine dédié complet ? + * architectures non prises en charge ? + * L'authentification unique ou l'intégration LDAP ne fonctionnent pas ? + * l'application nécessite une quantité importante de RAM / disque / ... pour s'installer ou fonctionner correctement. + * etc... +* D'autres informations que les gens devraient connaître, comme.. : + * toute étape spécifique à effectuer après l'installation (comme terminer manuellement l'installation, des identifiants d'administration spécifiques, ...) + * Comment configurer / administrer l'application si ce n'est pas évident. + * le processus de mise à niveau, les spécificités, les choses à savoir ? + * Considérations de sécurité +Traduit avec www.DeepL.com/Translator (version gratuite) ## Documentations et ressources -* Site Web officiel de l'application : https://remotestorage.io/ -* Dépôt de code de l'application en amont : https://github.com/remotestorage/armadietto/ -* Signalez un bogue : https://github.com/bencharp/armadietto_ynh/issues +* Site officiel de l'app : https://remotestorage.io/ +* Dépôt de code officiel de l'app : https://github.com/remotestorage/armadietto +* Documentation YunoHost pour cette app : https://yunohost.org/app_armadietto +* Signaler un bug : https://github.com/YunoHost-Apps/armadietto_ynh/issues ## Informations pour les développeurs -Veuillez envoyer votre demande à la [branche de test] (https://github.com/bencharp/armadietto_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing). -Pour essayer la branche testing, veuillez procéder comme suit. +Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/bencharp/armadietto_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug ou -sudo yunohost app upgrade armadietto_ynh -u https://github.com/bencharp/armadietto_ynh/tree/testing --debug +sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file