diff --git a/README.md b/README.md index 3d9e53a..bc219f0 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,44 @@ -# vaultwarden for YunoHost + + +# Vaultwarden for YunoHost [![Integration level](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.maintain.svg) -[![Install vaultwarden with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden) +[![Install Vaultwarden with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install vaultwarden quickly and simply on a YunoHost server. +> *This package allows you to install Vaultwarden 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 -vaultwarden is a open source password manager. -**Shipped version:** 1.22.1 +Manage passwords and other sensitive informations -## Important points to read before installing +**Shipped version:** 1.22.1~ynh1 -At the end of the installation, the admin user will receive a mail with the admin_token used to access https://your.domain.tld/vaultwarden/admin. +**Demo:** https://vault.bitwarden.com/#/register ## Screenshots -![](https://bitwarden.com/images/hero.png) +![](./doc/screenshots/screenshot1.png) -## Demo +## Disclaimers / important information -* [Official demo](https://vault.bitwarden.com/#/register) +* Other infos that people should be aware of, such as: + * At the end of the installation, the admin user will receive a mail with the admin_token used to access https://your.domain.tld/vaultwarden/admin. + * How to configure this app: by an admin panel at https://vaultwarden.domain.tld/admin. -## Configuration +## Documentation and resources -How to configure this app: by an admin panel at https://vaultwarden.domain.tld/admin. - -## Documentation - - * Official documentation: https://help.bitwarden.com/ and https://github.com/dani-garcia/vaultwarden/wiki - -## YunoHost specific features - -#### Multi-user support - -* Are LDAP and HTTP auth supported? **No** -* Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps.yunohost.org/ci/apps/vaultwarden/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps-arm.yunohost.org/ci/apps/vaultwarden/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/vaultwarden_ynh/issues - * App website: https://bitwarden.com/ - * Upstream app repository: https://github.com/dani-garcia/vaultwarden - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://bitwarden.com/ +* Official user documentation: https://help.bitwarden.com/ +* Official admin documentation: https://github.com/dani-garcia/vaultwarden/wiki +* Upstream app code repository: https://github.com/dani-garcia/vaultwarden +* YunoHost documentation for this app: https://yunohost.org/app_vaultwarden +* Report a bug: https://github.com/YunoHost-Apps/vaultwarden_ynh/issues ## Developer info @@ -64,3 +50,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/ or sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_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 9fa789d..d8507c9 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,58 +1,40 @@ -# vaultwarden pour YunoHost +# Vaultwarden pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/vaultwarden.svg)](https://dash.yunohost.org/appci/app/vaultwarden) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/vaultwarden.maintain.svg) -[![Installer vaultwarden avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden) +[![Installer Vaultwarden avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=vaultwarden) -*[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 vaultwarden rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Vaultwarden 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 -vaultwarden est un gestionnaire de mots de passe open source. -**Version incluse :** 1.22.1 +Gérez les mots de passe et autres informations sensibles -## Points importants à lire avant l'installation +**Version incluse :** 1.22.1~ynh1 -Après l'installation, l'utilisateur admin recevra un e-mail avec le admin_token à utiliser pour accéder à l'administration de vaultwarden https://your.domain.tld/vaultwarden/admin. +**Démo :** https://vault.bitwarden.com/#/register ## Captures d'écran -![](https://bitwarden.com/images/hero.png) +![](./doc/screenshots/screenshot1.png) -## Démo +## Avertissements / informations importantes -* [Démo officielle](https://vault.bitwarden.com/#/register) +* Other infos that people should be aware of, such as: + * At the end of the installation, the admin user will receive a mail with the admin_token used to access https://your.domain.tld/vaultwarden/admin. + * How to configure this app: by an admin panel at https://vaultwarden.domain.tld/admin. -## Configuration +## Documentations et ressources -Comment configurer cette application : via le panneau d'administration https://vaultwarden.domain.tld/admin. - -## Documentation - - * Documentation officielle : https://help.bitwarden.com/ et https://github.com/dani-garcia/vaultwarden/wiki - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge? **Non** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps.yunohost.org/ci/apps/vaultwarden/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/vaultwarden.svg)](https://ci-apps-arm.yunohost.org/ci/apps/vaultwarden/) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/vaultwarden_ynh/issues - * Site de l'application : https://bitwarden.com/ - * Dépôt de l'application principale : https://github.com/dani-garcia/vaultwarden - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://bitwarden.com/ +* Documentation officielle utilisateur : https://help.bitwarden.com/ +* Documentation officielle de l'admin : https://github.com/dani-garcia/vaultwarden/wiki +* Dépôt de code officiel de l'app : https://github.com/dani-garcia/vaultwarden +* Documentation YunoHost pour cette app : https://yunohost.org/app_vaultwarden +* Signaler un bug : https://github.com/YunoHost-Apps/vaultwarden_ynh/issues ## Informations pour les développeurs @@ -64,3 +46,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/ ou sudo yunohost app upgrade vaultwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file