Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 3.01 KB

README.md

File metadata and controls

82 lines (58 loc) · 3.01 KB
Raw

2FAuth Browser Extension

A Firefox/Chrome extension built in Angular for the awesome self-hosted 2FAuth project by Bubka.

Usage

  1. Generate a Personal Access Token for your account on your 2FAuth instance.
  2. Set the Host URL in the extension to point to your 2FAuth instance.
  3. Enter the token generated in step 1. into the Personal Access Token field in the extension settings.
  4. Save your settings.

The extension will load your preferences from the 2FAuth instance and use them to guide its appearance/behaviour.

The settings currently used include:

  • Show Icons
  • Password formatting
  • Copy OTP on display
  • Close OTP after copy

Simple Installation

Firefox

Option 1:

View the extension in the Mozilla Add-On store and click the "Add to Firefox" button.

Option 2:

Download the Firefox xpi for the latest release from here and open in Firefox.

Chrome

Option 1:

View the extension in the Chrome Extension store and click the "Add to Chrome" button.

Option 2:

Download the Chrome crx for the latest release from here, open chrome://extensions and drag the downloaded file onto the page.

Development Installation

Firefox

  1. Download the latest Firefox release or build using the instructions below.

  2. Disable the Firefox extension signing requirement.

    Firefox Extended Support Release (ESR), Firefox Developer Edition and Nightly versions of Firefox will allow you to override this setting by changing the preference xpinstall.signatures.required to false in the about:config page.

  3. Install the extension by going to about:addons and dragging the downloaded zip file onto the page.

Chrome

  1. Download and extract the latest Chrome release or build using the instructions below.

  2. Enable Developer Mode in Chrome.

    You can do this using the Developer Mode toggle in chrome://extensions.

  3. Click the Load Unpacked button and select the folder you extracted the extension to.

Development

Requirements

Commands

Dev builds

# Build all dev versions
npm run build

# Build Chrome dev version
npm run build:chrome

# Build Firefox dev version
npm run build:firefox

Distribution builds

# Build all distribution versions
npm run dist

# Build Chrome distribution version
npm run dist:chrome

# Build Firefox distribution version
npm run dist:firefox