LogoAwesome Homelab
Logo of 2FAuth Documentation

2FAuth Documentation

2FAuth is a self-hosted alternative to OTP generators like Google Authenticator for mobile and desktop.

Introduction

Welcome to 2FAuth Documentation

2FAuth is a web-based, self-hosted solution designed as an alternative to One Time Passcode (OTP) generators such as Google Authenticator. It offers a seamless experience across both mobile and desktop devices, ensuring users can access their two-factor authentication (2FA) codes anytime, anywhere. With a focus on privacy and control, 2FAuth empowers users to manage their security data independently.

Key Features
  • Generate Passwords: Provides fresh TOTP/HOTP security codes for secure access.
  • Cross-Platform Compatibility: Works on any device with an internet connection, eliminating the need for a specific device.
  • QR Code Scanning: Easily add 2FA accounts by scanning QR codes, supporting both 2FA and non-2FA codes.
  • 2FA Management: Organize, classify, edit, and delete 2FA accounts, with options for manual entry.
  • Data Protection: Features privacy-focused design, self-hosting, encryption, WebAuthn authentication, OTP obfuscation, and auto-lock.
  • Multi-User Support: Allows sharing with family or friends, with individual accounts for each user.
  • Import/Export: Simplifies migration from other 2FA apps or data export.
  • REST API: Offers a comprehensive API for integration with external applications.
  • Browser Extensions: Enhances accessibility with OTP generation directly from browser toolbars (requires a running 2FAuth instance).
Use Cases

2FAuth is ideal for individuals and small groups seeking a secure, self-hosted 2FA solution. It caters to tech-savvy users who prioritize privacy and data control, as well as those who need a reliable alternative to smartphone-based authenticators. Whether you're managing personal accounts or sharing access within a trusted circle, 2FAuth provides a flexible and user-friendly platform to enhance security.