mirror of https://github.com/YunoHost-Apps/2FAuth_ynh.git synced 2024-09-03 20:36:18 +02:00

2FAuth package for YunoHost

2fauth

Find a file

yunohost-bot 2b89a1ab70 Auto-update README		2022-08-02 06:14:02 +00:00
.github	Merge pull request #4 from YunoHost-Apps/ericgaspar-patch-1	2022-05-10 08:44:52 +02:00
conf	3.2.0	2022-07-18 17:01:43 +02:00
doc	Update DISCLAIMER.md	2022-05-15 10:23:42 +02:00
scripts	Update upgrade	2022-05-15 09:38:43 +02:00
check_process	Update check_process	2022-05-10 10:06:56 +02:00
config_panel.toml.example	First commit	2022-03-25 18:30:41 +01:00
LICENSE	First commit	2022-03-25 18:30:41 +01:00
manifest.json	Upgrade to v3.3.0	2022-08-02 06:13:59 +00:00
README.md	Auto-update README	2022-08-02 06:14:02 +00:00
README_fr.md	Auto-update README	2022-08-02 06:14:02 +00:00

README.md

2FAuth for YunoHost

Lire ce readme en français.

This package allows you to install 2FAuth quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide 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.3.0~ynh1

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

Screenshots

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.

To try the testing branch, please proceed like that.

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