Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,25 @@
[![installs on Packagist](https://img.shields.io/packagist/dt/bitexpert/sylius-2fa-plugin)](https://packagist.org/packages/bitexpert/sylius-2fa-plugin/)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/109408681246972700?domain=https://rheinneckar.social)](https://rheinneckar.social/@bitexpert)

The **2FA** Plugin for *Sylius* allows admin users and shop users to enable two-factor authentication for their accounts. Users can choose between 2FA via Google Authenticator or email.

### 3-step Setup workflow:

![Setup 2FA for a user account](docs/assets/setup_workflow.png)

### 2-step Login workflow:

![Login workflow with 2FA enabled](docs/assets/login.png)

## Features:
* Admin users and shop users can enable two-factor authentication for their accounts
* Choose between Google Authenticator or email as an authentication method
* During login users can choose which authentication method to use

## Requirements:
* PHP 8.2 or higher
* Sylius 2.0 or higher


## Installation

1. Install the plugin via Composer
Expand Down
Binary file added docs/assets/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/setup_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file removed tests/Unit/.gitignore
Empty file.