Download the PHP package maize-tech/laravel-magic-login without Composer

# Laravel Magic Login [](https://packagist.org/packages/maize-tech/laravel-magic-login) [](https://github.com/maize-tech/laravel-magic-login/actions?query=workflow%3Arun-tests+branch%3Amain) [](https://github.com/maize-tech/laravel-magic-login/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) [](https://packagist.org/packages/maize-tech/laravel-magic-login) Easily add passwordless authentication into your application. ## Installation You can install the package via composer: You can publish the config and migration files and run the migrations with: This is the contents of the published config file: ## Usage ### Basic To use the package, all you have to do is include the magic link route in your routes file. By default, you should include it under `routes/web.php`: That's it! Once done, you can already generate an invitation link to any model extending the `Authenticatable` class using the `make` method: ### Email notifications #### Send an email notification Optionally, you may also automatically send an email notification to the given user using the `send` method: which is equals to using the `make` method with the `notify` parameter set to `true`: #### Customize the notification class When needed, you can customize the email notification. All you have to do is create your own notification and override the default `MagicLinkNotification` class: Finally, you can update the `notification` attribute under `config/magic-login.php` with the new class path. ### Force single link When enabled, users can only have one valid link at a time. This means that when a new link is created, all previously created links are invalidated. To enable this option, you can set the `force_single` attribute under `config/magic-login.php` to `true`. ### Magic link generator options The package offers many useful parameters for the `make` method to allow you customizing every single magic link: - [`Redirect url`](#redirect-url) - [`Expiration time`](#expiration-time) - [`Route name`](#route-name) - [`Authentication guard`](#authentication-guard) - [`Logins limit`](#logins-limit) - [`Custom metadata`](#custom-metadata) #### Redirect url You can provide a redirect url used after authenticating the user: When not provided, the default value defined in `redirect_url` attribute under `config/magic-login.php` will be used. #### Expiration time You can define the amount of time before a magic link expires by providing a carbon instance or an integer with the amount of minutes: When not provided, the default value defined in `expiration` attribute under `config/magic-login.php` will be used. #### Route name You can define the route name used to generate the magic link: When not provided, the default value defined in `route.name` attribute under `config/magic-login.php` will be used. #### Authentication guard You can define the authentication guard used to authenticate the user: When not provided, the default value defined in `guard` attribute under `config/magic-login.php` will be used. #### Logins limit You can define the amount of times a single link can be used before expiring. The value can be either -1, which lets the user login indefinitely, or any number greater than or equal to 1: When not provided, the default value defined in `logins_limit` attribute under `config/magic-login.php` will be used. #### Custom metadata Optionally, you can store custom metadata in case you need to perform custom queries. ## Testing ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Contributing Please see [CONTRIBUTING](https://github.com/maize-tech/.github/blob/main/CONTRIBUTING.md) for details. ## Security Vulnerabilities Please review [our security policy](https://github.com/maize-tech/.github/security/policy) on how to report security vulnerabilities. ## Credits - [Enrico De Lazzari](https://github.com/enricodelazzari) - [All Contributors](../../contributors) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.