YunoHost-Apps/armadietto_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/armadietto_ynh.git synced 2024-09-03 18:06:18 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-05-27 15:03:37 +00:00
parent c9c2b1f479
commit c8d75bf39d
2 changed files with 25 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -5,7 +5,7 @@ It shall NOT be edited by hand.
# Armadietto for YunoHost # 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) [![Integration level](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![Working status](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![Maintenance status](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) [![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)* *[Lire ce readme en français.](./README_fr.md)*
@ -15,7 +15,6 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
## Overview ## Overview
[Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js. [Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js.
Armadietto is maintained by the remoteStorage community, ([IRC](https://web.libera.chat/#remotestorage), [forums](https://community.remotestorage.io/)). Armadietto is maintained by the remoteStorage community, ([IRC](https://web.libera.chat/#remotestorage), [forums](https://community.remotestorage.io/)).
@ -27,8 +26,6 @@ Armadietto is maintained by the remoteStorage community, ([IRC](https://web.libe
> SHOULD expect that its APIs and storage schemas will change before it is > SHOULD expect that its APIs and storage schemas will change before it is
> labelled stable. > labelled stable.
**Shipped version:** 0.1.5
### Installation option ### Installation option
User registration is not allowed out of the box. User registration is not allowed out of the box.
@ -39,14 +36,11 @@ This option can be enabled in the configuration panel.
[Here](https://remotestorage.io/apps/) is a non-exhaustive list of apps that have integrated remoteStorage as a storage/sync option. [Here](https://remotestorage.io/apps/) is a non-exhaustive list of apps that have integrated remoteStorage as a storage/sync option.
**Shipped version:** 0.1.5~ynh1
**Shipped version:** 0.0.7~ynh1
## Screenshots ## Screenshots
![](./doc/screenshots/armadietto.png) ![Screenshot of Armadietto](./doc/screenshots/armadietto.png)
## Disclaimers / important information ## Disclaimers / important information
@ -81,34 +75,23 @@ The Armadietto_ynh package is still under development, so you should expect some
- RemoteStorage requires browser-approved SSL certificates. If you have certificates not issued by [Let's Encrypt](https://letsencrypt.org/), install them manually as usual. - RemoteStorage requires browser-approved SSL certificates. If you have certificates not issued by [Let's Encrypt](https://letsencrypt.org/), install them manually as usual.
## TODO
* Any known limitations, constraints or non-functioning elements, such as (but not limited to) :
* Unsupported architectures?
* Single sign-on or LDAP integration not working?
* etc...
* Other information that people should know, such as. :
* any specific steps to be performed after installation (like manually terminating the installation, specific admin credentials, ...)
* How to configure / administer the application if it is not obvious.
* Specifics, things to know?
## Documentation and resources ## Documentation and resources
* Official app website: https://remotestorage.io/ * Official app website: <https://remotestorage.io/>
* Upstream app code repository: https://github.com/remotestorage/armadietto * Upstream app code repository: <https://github.com/remotestorage/armadietto>
* YunoHost documentation for this app: https://yunohost.org/app_armadietto * YunoHost documentation for this app: <https://yunohost.org/app_armadietto>
* Report a bug: https://github.com/YunoHost-Apps/armadietto_ynh/issues * Report a bug: <https://github.com/YunoHost-Apps/armadietto_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/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. To try the testing branch, please proceed like that.
```
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug
or or
sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/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 **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

41
README_fr.md
View file

@ -1,17 +1,20 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# Armadietto pour YunoHost # Armadietto pour YunoHost
[![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) [![Niveau d'intégration](https://dash.yunohost.org/integration/armadietto.svg)](https://dash.yunohost.org/appci/app/armadietto) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/armadietto.status.svg) ![Statut de maintenance](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) [![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)* *[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. > *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.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
[Armadietto](https://github.com/remotestorage/armadietto/) est un serveur [remoteStorage](https://remotestorage.io) écrit pour Node.js. [Armadietto](https://github.com/remotestorage/armadietto/) est un serveur [remoteStorage](https://remotestorage.io) écrit pour Node.js.
Armadietto est maintenu par la communauté remoteStorage, ([IRC](https://web.libera.chat/#remotestorage), [forums](https://community.remotestorage.io/)). Armadietto est maintenu par la communauté remoteStorage, ([IRC](https://web.libera.chat/#remotestorage), [forums](https://community.remotestorage.io/)).
@ -23,8 +26,6 @@ Armadietto est maintenu par la communauté remoteStorage, ([IRC](https://web.lib
> Vous devez vous attendre à ce que ses API et ses schémas de stockage changent avant qu'il ne soit > Vous devez vous attendre à ce que ses API et ses schémas de stockage changent avant qu'il ne soit
> étiqueté comme stable. > étiqueté comme stable.
**Version livrée:** 0.1.5
### Option d'installation ### Option d'installation
L'inscription des utilisateurs n'est pas autorisée par défault. L'inscription des utilisateurs n'est pas autorisée par défault.
@ -34,13 +35,12 @@ Cette option peut être activée via le panneau de configutration.
[Cliquez ici](https://remotestorage.io/apps/) pour voir une liste non exhaustive d'applications ayant intégré remoteStorage comme option de stockage/synchronisation. [Cliquez ici](https://remotestorage.io/apps/) pour voir une liste non exhaustive d'applications ayant intégré remoteStorage comme option de stockage/synchronisation.
**Version incluse :** 0.0.7~ynh1
**Version incluse :** 0.1.5~ynh1
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/armadietto.png) ![Capture d'écran de Armadietto](./doc/screenshots/armadietto.png)
## Avertissements / informations importantes ## Avertissements / informations importantes
@ -75,34 +75,23 @@ Le paquet Armadietto_ynh est toujours en cours de développement, vous devez don
- 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. - 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.
## TODO
* Toute limitation ou contrainte connue ou tout élément ne fonctionnant pas, tel que (mais non limité à) :
* architectures non prises en charge ?
* L'authentification unique ou l'intégration LDAP ne fonctionnent pas ?
* 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.
* Spécificités, les choses à savoir ?
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://remotestorage.io/ * Site officiel de l'app : <https://remotestorage.io/>
* Dépôt de code officiel de l'app : https://github.com/remotestorage/armadietto * Dépôt de code officiel de l'app : <https://github.com/remotestorage/armadietto>
* Documentation YunoHost pour cette app : https://yunohost.org/app_armadietto * Documentation YunoHost pour cette app : <https://yunohost.org/app_armadietto>
* Signaler un bug : https://github.com/YunoHost-Apps/armadietto_ynh/issues * Signaler un bug : <https://github.com/YunoHost-Apps/armadietto_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/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, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
```
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade armadietto -u https://github.com/YunoHost-Apps/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 **Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>