HydroBlockchain / oc-raindrop-plugin

Repo for Raindrop MFA Plugin for OctoberCMS
MIT License
1 stars 1 forks source link

Hydro Raindrop for October CMS

October CMS Logo

Welcome to the Hydro Raindrop October CMS plugin repository on GitHub.

Hydro Logo

Hydro Raindrop 2FA vs Google Authenticator

Features

Note: Free Hydro Mobile App is required to complete the MFA process. You can get iOS App here or the Android App here.

Requirements

Installation

There are different ways to install this plugin. We recommend to install it from October CMS back-end.

From October CMS (recommended)

  1. Log in to the back-end of October CMS.
  2. Navigate to Settings in the Main Menu.
  3. Scroll down to SYSTEM and click on Updates & Plugins.
  4. Click the button + Install plugins.
  5. Search for 'Raindrop'.
  6. Select the plugin and it will begin installing.

Using Composer

Execute the following commands from CLI (make sure your current working directory is at the October CMS root):

Manually

Configuration

1. Settings

  1. Log in to the back-end of October CMS.
  2. Navigate to Settings in the Main Menu.
  3. Scroll down to USERS and click on Hydro Raindrop.
  4. At the tab General select the Login Page and the Redirect Page.
  5. Enter your Application ID, Client ID and Client Secret in the API Settings tab.
  6. Make some adjustments for your project in the Customization tab.

2. Implementation into your theme.

Install the HydroRaindropDemo theme which includes an example implementation of Hydro Raindrop MFA.

Events

Event Payload Description
hydrocommunity.raindrop.user.mfa.enabled User Fired when user successfully enabled MFA on their account.
hydrocommunity.raindrop.user.mfa.disabled User Fired when user has disabled MFA on their account.
hydrocommunity.raindrop.user.mfa.setup-required User Fired when user needs to set up their HydroID.
hydrocommunity.raindrop.user.mfa.required User Fired when user needs to perform MFA.
hydrocommunity.raindrop.user.blocked User Fired after a user is blocked due to many failed MFA attempts.
hydrocommunity.raindrop.mfa.session-timed-out User Fired after the MFA session has been timed out.

Commands

Command Description
hydro-community:raindrop:install-pages Install required pages for the Hydro Raindrop plugin.