2fauth_ynh/README.md

<!--
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.
-->

# 2FAuth for YunoHost

[![Integration level](https://dash.yunohost.org/integration/2fauth.svg)](https://dash.yunohost.org/appci/app/2fauth) ![Working status](https://ci-apps.yunohost.org/ci/badges/2fauth.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/2fauth.maintain.svg)
[![Install 2FAuth with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=2fauth)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install 2FAuth 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

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

**Shipped version:** 3.4.2~ynh1

**Demo:** https://demo.2fauth.app/login

## Screenshots

![Screenshot of 2FAuth](./doc/screenshots/screenshot.png)

## Disclaimers / important information

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/
## Documentation and resources

* Official admin documentation: <https://docs.2fauth.app/>
* Upstream app code repository: <https://github.com/Bubka/2FAuth>
* YunoHost documentation for this app: <https://yunohost.org/app_2fauth>
* Report a bug: <https://github.com/YunoHost-Apps/2fauth_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
or
sudo yunohost app upgrade 2fauth -u https://github.com/YunoHost-Apps/2fauth_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>