YunoHost-Apps/2fauth_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/2FAuth_ynh.git synced 2024-09-03 20:36:18 +02:00
Code Issues Activity Actions
2FAuth package for YunoHost
7 commits 6 branches 0 tags 805 KiB
Shell 100%
Find a file
ericgaspar 30ee1d8881
Update restore
2022-03-25 19:49:37 +01:00
conf First commit 2022-03-25 18:30:41 +01:00
doc Update DISCLAIMER.md 2022-03-25 19:19:29 +01:00
scripts Update restore 2022-03-25 19:49:37 +01:00
check_process First commit 2022-03-25 18:30:41 +01: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 First commit 2022-03-25 18:30:41 +01:00
README.md Auto-update README 2022-03-25 17:30:47 +00:00
README_fr.md Auto-update README 2022-03-25 17:30:47 +00:00

README.md

2FAuth for YunoHost

Integration level
Install 2FAuth with 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: 2.1.0~ynh1

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

Screenshots

Disclaimers / important information

  • 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 ?

Documentation and resources

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