Skip to content

Commit d2af4de

Browse files
committed
docs: how upgrade to next ver
1 parent b92af36 commit d2af4de

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

UPGRADING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,34 @@
11
# Upgrade Guide
2+
## Version 1.2.0 to 1.3.0
3+
4+
### Mandatory Config Changes
5+
6+
A new configuration option has been introduced for controlling how Magic Login codes are generated and delivered.
7+
The following property must be added in **app/Config/Auth.php**.
8+
9+
```php
10+
/**
11+
* --------------------------------------------------------------------
12+
* Magic Login Mode
13+
* --------------------------------------------------------------------
14+
* Determines how magic login works:
15+
*
16+
* - 'clickable' => send an email with a clickable link (default)
17+
* - '<length>-numeric' => send a numeric code with the specified length
18+
* - '<length>-alpha' => send an alphabetic code with the specified length
19+
* - '<length>-alnum' => send an alphanumeric code with the specified length
20+
* - '<length>-oneof' => send a code of the specified length; system chooses
21+
* automatically one of: numeric, alpha, or alnum
22+
*
23+
* Examples:
24+
* 'clickable'
25+
* '6-numeric' // 6-digit numeric code
26+
* '8-alpha' // 8-letter alphabetic code
27+
* '7-alnum' // 7-character alphanumeric code
28+
* '6-oneof' // 6-character code, chosen automatically
29+
*/
30+
public string $magicLoginMode = 'clickable';
31+
```
232

333
## Version 1.0.0-beta.8 to 1.0.0
434

0 commit comments

Comments
 (0)