update manifest & docs

doc/DESCRIPTION.md

@@ -1,6 +1,21 @@
-## TODO
+## Armadietto overview
 
-Une description longue de ce que fait l'application
+[Armadietto](https://github.com/remotestorage/armadietto/) is a [remoteStorage](https://remotestorage.io) server written for Node.js.
+
+Armadietto is maintained by remoteStorage Team [IRC](https://kiwiirc.com/client/irc.freenode.net/#remotestorage)
+
+> ### :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
+
+### Application for remoteStorage
+
+[Click here](https://remotestorage.io/apps/) to see the list of applications that can be used with RemoteStorage.
 
 ### Features
 

doc/DESCRIPTION_fr.md

@@ -0,0 +1,18 @@
+## 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
+
+### Application pour remoteStorage
+
+[Cliquez ici](https://remotestorage.io/apps/) pour voir la liste des applications qui peuvent être utilisées avec RemoteStorage.

doc/DISCLAIMER.md

@@ -1,16 +1,45 @@
+## Disclaimers / important information
+
+### :warning: WARNING
+Armadietto_ynh still in develoment:
+
+* The upgrade process is not yet operational
+* Single sign-on or LDAP integration not working?
+* Security considerations from [Armadietto](https://github.com/remotestorage/armadietto/) :
+
+> Storage security
+>
+> In production, we recommend that you restrict access to the files managed by your armadietto server as much as possible. This is particularly true if you host your storage on a machine with other web applications; you need to protect your files in the event that one of those apps is exploited.
+> 
+> You should take these steps to keep your storage safe:
+> 
+>     Pick a unique Unix user to run your server process; no other process on the box should run as this user: sudo useradd armadietto --system --no-create-home
+> 
+>     Do not run other applications as root, or as any user that could access files owned by your armadietto user
+> 
+>     Make sure the directory path/to/storage cannot be read, written or executed by anyone but this user: sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
+> 
+>     Do not run armadietto as root; if you need to bind to port 80 or 443 use a reverse proxy like nginx, Apache2, caddy, lighttpd or enable bind capability: setcap 'cap_net_bind_service=+ep' `which armadietto`
+> 
+>     Ideally, run your storage inside a container or on a dedicated machine
+
+
+### 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.
+
+- 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
 
-* Toute limitation ou contrainte connue ou tout élément ne fonctionnant pas, tel que (mais non limité à) :
+* Any known limitations, constraints or non-functioning elements, such as (but not limited to) :
-    * nécessitant un domaine dédié complet ?
+    * Unsupported architectures?
-    * architectures non prises en charge ?
+    * Single sign-on or LDAP integration not working?
-    * 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.. :
+* Other information that people should know, such as. :
-    * toute étape spécifique à effectuer après l'installation (comme terminer manuellement l'installation, des identifiants d'administration spécifiques, ...)
+    * any specific steps to be performed after installation (like manually terminating the installation, specific admin credentials, ...)
-    * Comment configurer / administrer l'application si ce n'est pas évident.
+    * How to configure / administer the application if it is not obvious.
-    * le processus de mise à niveau, les spécificités, les choses à savoir ?
+    * Specifics, things to know?
-    * Considérations de sécurité
-
-Traduit avec www.DeepL.com/Translator (version gratuite)

doc/DISCLAIMER_fr.md

@@ -0,0 +1,46 @@
+## Avertissements / informations importantes
+
+### :warning: WARNING
+Armadietto_ynh still in develoment:
+* le processus de mise à niveau n'est pas encore opérationnel
+* l'authentification unique ou l'intégration LDAP ne fonctionne pas ?
+* Considérations sur la sécurité de [Armadietto](https://github.com/remotestorage/armadietto/) :
+
+> Sécurité du stockage
+>
+> En production, nous vous recommandons de restreindre autant que possible l'accès aux fichiers gérés par votre serveur armadietto. Ceci est particulièrement vrai si vous hébergez votre stockage sur une machine avec d'autres applications web ; vous devez protéger vos fichiers dans le cas où l'une de ces applications serait exploitée.
+> 
+> Vous devez prendre les mesures suivantes pour assurer la sécurité de votre stockage :
+> 
+> Choisissez un utilisateur Unix unique pour exécuter votre processus serveur ; aucun autre processus sur la machine ne doit être exécuté sous cet utilisateur : sudo useradd armadietto --system --no-create-home
+> 
+> Ne lancez pas d'autres applications en tant que root, ou en tant qu'utilisateur qui pourrait accéder à des fichiers appartenant à votre utilisateur armadietto.
+> 
+> Assurez-vous que le répertoire path/to/storage ne peut être lu, écrit ou exécuté par personne d'autre que cet utilisateur : sudo chmod 0700 /path/to/storage && sudo chown armadietto /path/to/storage
+> 
+> Ne lancez pas armadietto en tant que root ; si vous avez besoin de vous lier au port 80 ou 443, utilisez un reverse proxy comme nginx, Apache2, caddy, lighttpd ou activez la capacité de liaison : setcap 'cap_net_bind_service=+ep' `which armadietto`.
+> 
+> Idéalement, exécutez votre stockage dans un conteneur ou sur une machine dédiée.
+
+Traduit avec www.DeepL.com/Translator (version gratuite)
+
+### 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.
+
+- 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 ?

manifest.json

@@ -3,8 +3,8 @@
     "id": "armadietto",
     "packaging_format": 1,
     "description": {
-        "en": "Armadietto is a remoteStorage server written for Node.js.",
+        "en": "A remoteStorage server written for Node.js.",
-        "fr": "Armadietto est un serveur remoteStorage écrit pour node.js."
+        "fr": "Un serveur remoteStorage écrit pour node.js."
     },
     "version": "0.0.2-beta.10~ynh3",
     "url": "https://github.com/remotestorage/armadietto",