extern/2FAuth
1
0
Fork 0
mirror of https://github.com/Bubka/2FAuth.git synced 2024-11-26 02:04:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Enhance README.md

Browse Source
This commit is contained in:
Bubka 2020-10-08 22:27:56 +02:00
parent 92a38c4dbb
commit 342d656724
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -13,21 +13,25 @@ #### [2FAuth Demo](https://demo.2fauth.app/)
Credentials (login - password) : *demo@2fauth.app* - *demo* Credentials (login - password) : *demo@2fauth.app* - *demo*
## Purpose ## Purpose
2FAuth is a web based self-hosted alternative to One Time Passcode (OTP) generators like Google Authenticator that you can use both on mobile or desktop. 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.
I created it because : I created it because :
* Most of the UIs for this kind of apps show tokens for all accounts in the same time with stressful countdowns (in my opinion) * Most of the UIs for this kind of apps show tokens for all accounts in the same time with stressful countdowns (in my opinion)
* I wanted my 2FA accounts to be stored in a database I can easily backup and restore. * I wanted my 2FA accounts to be stored in a standalone database I can easily backup and restore (did you already encountered a smartphone loss with all your 2FA accounts in Google Auth? I did...)
* I hate taking out my smartphone to get an OTP when I use a desktop computer. * I hate taking out my smartphone to get an OTP when I use a desktop computer
* I love coding and I love self-hosted solution * I love coding and I love self-hosted solutions
## Features ## Main features
* Manage 2FA accounts with QR code scanning and decoding * Manage 2FA accounts with QR code flashing/scanning and decoding
* Generate TOTP and HOTP tokens * Generate TOTP and HOTP security codes
* User authentication to protect access to 2FA accounts * User authentication to protect 2FA data stored in 2FAuth
2FAuth is currently localized in English and in French.
#### Single user app #### Single user app
2FA are sensitives data so an authentication is needed to use the app. And because they are usually owned by the same person, it is not possible to create more than one account. 2FA are sensitives data so you have to create an account and authenticate yourself to use the app. It is not possible to create more than one user account, the app is thought for personal use.
#### RFC compliance #### RFC compliance
2FAuth generates OTP according to RFC 4226 (HOTP Algorithm) and RFC 6238 (TOTP Algorithm) thanks to [Spomky-Labs/OTPHP](https://github.com/Spomky-Labs/otphp) php library. 2FAuth generates OTP according to RFC 4226 (HOTP Algorithm) and RFC 6238 (TOTP Algorithm) thanks to [Spomky-Labs/OTPHP](https://github.com/Spomky-Labs/otphp) php library.
@ -70,13 +74,13 @@ #### Prepare some stuff
You are ready to go. You are ready to go.
#### For development only #### For development only
Install and build js dependencies Checkout the 'dev' branch then install and build js dependencies
``` ```
npm install npm install
npm run dev npm run dev
``` ```
## Update your installation ## Upgrading
First, **backup your database**. First, **backup your database**.
Then, using command line : Then, using command line :