mirror of
https://github.com/YunoHost-Apps/armadietto_ynh.git
synced 2024-09-03 18:06:18 +02:00
6ad2b3dd43
* Fix * Update manifest.json * report @raucao patch-1 & liitle doc corrections * Auto-update README * update config_panel, manifest, check, doc... * Auto-update README * Auto-update README * add signup config (#11) Co-authored-by: Yunohost-Bot <> @ericgaspar * fix details * add npm package version * Auto-update README Co-authored-by: ericgaspar <junk.eg@free.fr> Co-authored-by: Yunohost-Bot <>
108 lines
No EOL
5.8 KiB
Markdown
108 lines
No EOL
5.8 KiB
Markdown
# Armadietto pour YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/armadietto)  
|
||
[](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
|
||
|
||
|
||
[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/)).
|
||
|
||
> ### :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
|
||
|
||
### Option d'installation
|
||
|
||
L'inscription des utilisateurs n'est pas autorisée par défault.
|
||
Cette option peut être activée via le panneau de configutration.
|
||
|
||
### Application pour remoteStorage
|
||
|
||
[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
|
||
|
||
|
||
|
||
## Captures d'écran
|
||
|
||
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
### :warning: WARNING
|
||
Le paquet Armadietto_ynh est toujours en cours de développement, vous devez donc vous attendre à d'éventuels changements non documentés avant qu'il ne soit qualifié de stable.
|
||
|
||
### :information_source: 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.
|
||
|
||
<br />
|
||
|
||
### **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 ?
|
||
## Documentations et ressources
|
||
|
||
* 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
|
||
|
||
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.
|
||
```
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/armadietto_ynh/tree/testing --debug
|
||
ou
|
||
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 |