Skip to content

Commit

Permalink
[Docs] Added config to ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
janicerar committed Oct 22, 2018
1 parent 37942ad commit 656501d
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## LifeOnScreen/nova-google2fa

This package enforces 2FA for Laravel Nova.

## Installation

Install via composer
Expand Down Expand Up @@ -45,6 +49,47 @@ Add middleware to `nova.config`.
]
```

## Config

```php
return [
/**
* Disable or enable middleware.
*/
'enabled' => env('GOOGLE_2FA_ENABLED', true),

'models' => [
/**
* Change this variable to your User model.
*/
'user' => 'App\User',
],
'tables' => [
/**
* Table in witch users are stored.
*/
'user' => 'users',
],

'recovery_codes' => [
/**
* Number of recovery codes that will be generated.
*/
'count' => 8,

/**
* Number of blocks in each recovery code.
*/
'blocks' => 3,

/**
* Number of characters in each block in recovery code.
*/
'chars_in_block' => 16,
],
];
```

## Security

If you discover any security-related issues, please email the author instead of using the issue tracker.
Expand Down

0 comments on commit 656501d

Please sign in to comment.