mirror of
https://github.com/YunoHost-Apps/2FAuth_ynh.git
synced 2024-09-03 20:36:18 +02:00
67 lines
No EOL
2.9 KiB
Markdown
67 lines
No EOL
2.9 KiB
Markdown
# 2FAuth pour YunoHost
|
||
|
||
[![Niveau d'intégration](https://dash.yunohost.org/integration/2fauth.svg)](https://dash.yunohost.org/appci/app/2fauth) ![](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg)
|
||
[![Installer 2FAuth avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
*[Lire ce readme en français.](./README_fr.md)*
|
||
|
||
> *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.*
|
||
|
||
## Vue d'ensemble
|
||
|
||
2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator, designed for both mobile and desktop.
|
||
|
||
It aims to ease you perform your 2FA authentication steps whatever the device you handle, with a clean and suitable interface.
|
||
|
||
### Features
|
||
|
||
- 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
|
||
|
||
**Version incluse :** 2.1.0~ynh1
|
||
|
||
**Démo :** https://demo.2fauth.app/login
|
||
|
||
## Captures d'écran
|
||
|
||
![](./doc/screenshots/screenshot.png)
|
||
|
||
## 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 : https://example.com
|
||
* Dépôt de code officiel de l'app : https://github.com/Bubka/2FAuth
|
||
* Documentation YunoHost pour cette app : https://yunohost.org/app_2fauth
|
||
* Signaler un bug : https://github.com/YunoHost-Apps/2fauth_ynh/issues
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
```
|
||
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
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps |