mirror of
https://github.com/YunoHost-Apps/hat_ynh.git
synced 2024-09-03 19:16:04 +02:00
86 lines
3.3 KiB
Markdown
86 lines
3.3 KiB
Markdown
<!--
|
||
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.
|
||
-->
|
||
|
||
# Hat.sh pour YunoHost
|
||
|
||
[![Niveau d'intégration](https://dash.yunohost.org/integration/hat.svg)](https://dash.yunohost.org/appci/app/hat) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/hat.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/hat.maintain.svg)
|
||
[![Installer Hat.sh avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hat)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d'installer Hat.sh 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
|
||
|
||
Hat.sh is a web app that provides secure local file encryption in the browser. It's fast, secure, and uses modern cryptographic algorithms with chunked AEAD stream encryption/decryption.
|
||
|
||
### Features
|
||
|
||
#### Security
|
||
|
||
- XChaCha20-Poly1305 - for symmetric encryption.
|
||
- Argon2id - for password-based key derivation.
|
||
- X25519 - for key exchange.
|
||
|
||
#### Privacy
|
||
|
||
- The app runs locally in your browser.
|
||
- No data is ever collected or sent to anyone.
|
||
|
||
#### Functionality
|
||
|
||
- Secure multiple file encryption/decryption with passwords or keys.
|
||
- Secure random password generation.
|
||
- Asymmetric key pair generation.
|
||
- Authenticated key exchange.
|
||
- Password strength estimation.
|
||
|
||
|
||
**Version incluse :** 2.3.5~ynh1
|
||
|
||
**Démo :** https://hat.sh
|
||
|
||
## Captures d'écran
|
||
|
||
![Capture d'écran de Hat.sh](./doc/screenshots/screenshot.gif)
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||
* requiring a full dedicated domain ?
|
||
* architectures not supported ?
|
||
* not-working single-sign on or LDAP integration ?
|
||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||
* etc...
|
||
|
||
* Other infos that people should be aware of, such as:
|
||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||
* how to configure / administrate the application if it ain't obvious
|
||
* upgrade process / specificities / things to be aware of ?
|
||
* security considerations ?
|
||
|
||
## Documentations et ressources
|
||
|
||
* Site officiel de l'app : <hat.sh>
|
||
* Documentation officielle utilisateur : <https://yunohost.org/apps>
|
||
* Documentation officielle de l'admin : <https://hat.sh/about/>
|
||
* Dépôt de code officiel de l'app : <https://github.com/sh-dv/hat.sh>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_hat>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/hat_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/hat_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/hat_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade hat -u https://github.com/YunoHost-Apps/hat_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|