2022-06-01 07:59:04 +02:00
<!--
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.
-->
2022-03-25 18:30:47 +01:00
# 2FAuth pour YunoHost
2022-03-25 18:30:41 +01:00
2023-01-25 14:03:52 +01:00
[![Niveau d’ intégration ](https://dash.yunohost.org/integration/2fauth.svg )](https://dash.yunohost.org/appci/app/2fauth) ![Statut du fonctionnement ](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg ) ![Statut de maintenance ](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg )
2022-03-25 18:30:47 +01:00
[![Installer 2FAuth avec YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=2fauth)
2022-03-25 18:30:41 +01:00
*[Read this readme in english.](./README.md)*
2023-01-25 14:03:52 +01:00
> *Ce package vous permet d’ installer 2FAuth 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.*
2022-03-25 18:30:41 +01:00
2023-01-25 14:03:52 +01:00
## Vue d’ ensemble
2022-03-25 18:30:41 +01:00
2022-03-25 18:30:47 +01:00
2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator, designed for both mobile and desktop.
2022-03-25 18:30:41 +01:00
2022-03-25 18:30:47 +01:00
It aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface.
2022-03-25 18:30:41 +01:00
2022-03-25 18:30:47 +01:00
### Features
2022-03-25 18:30:41 +01:00
2022-03-25 18:30:47 +01:00
- Manage your 2FA accounts and organize them using Groups
- Scan and decode any QR code to add account in no time
- Add custom account without QR code thanks to an advanced form
- Edit accounts, even the imported ones
- Generate TOTP and HOTP security codes
2022-03-25 18:30:41 +01:00
2023-01-07 13:51:14 +01:00
**Version incluse :** 3.4.1~ynh2
2022-03-25 18:30:41 +01:00
2022-03-25 18:30:47 +01:00
**Démo :** https://demo.2fauth.app/login
2022-03-25 18:30:41 +01:00
2023-01-25 14:03:52 +01:00
## Captures d’ écran
2022-03-25 18:30:41 +01:00
2023-01-25 14:03:52 +01:00
![Capture d’ écran de 2FAuth ](./doc/screenshots/screenshot.png )
2022-03-25 18:30:41 +01:00
2022-05-15 10:23:47 +02:00
## Avertissements / informations importantes
2FAuth has been imagined for personal use only, it is single user designed.
You have to create a user account to use the app and you cannot create more than one user account.
Authentication documentation: https://docs.2fauth.app/security/authentication/
2022-03-25 18:30:41 +01:00
## Documentations et ressources
2023-01-25 14:03:52 +01:00
* Documentation officielle de l’ admin : < https: // docs . 2fauth . app />
* Dépôt de code officiel de l’ app : < https: // github . com / Bubka / 2FAuth >
2022-06-01 07:59:04 +02:00
* Documentation YunoHost pour cette app : < https: // yunohost . org / app_2fauth >
* Signaler un bug : < https: // github . com / YunoHost-Apps / 2fauth_ynh / issues >
2022-03-25 18:30:41 +01:00
## Informations pour les développeurs
2022-03-25 18:30:47 +01:00
Merci de faire vos pull request sur la [branche testing ](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing ).
2022-03-25 18:30:41 +01:00
Pour essayer la branche testing, procédez comme suit.
2022-06-01 07:59:04 +02:00
``` bash
2022-03-25 18:30:47 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
ou
sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
2022-03-25 18:30:41 +01:00
```
2023-01-25 14:03:52 +01:00
**Plus d’ infos sur le packaging d’ applications :** < https: / / yunohost . org / packaging_apps >