Tyro Login Documentation

composer require hasinhayder/tyro-login
php artisan tyro-login:install

# Available layouts: 'centered', 'split-left', 'split-right', 'fullscreen', 'card'
TYRO_LOGIN_LAYOUT=centered

# Background image for split and fullscreen layouts
TYRO_LOGIN_BACKGROUND_IMAGE=https://images.unsplash.com/photo-1618005182384-a83a8bd57fbe

return [
    'layout' => env('TYRO_LOGIN_LAYOUT', 'centered'),
    'background_image' => env('TYRO_LOGIN_BACKGROUND_IMAGE', 'https://...'),
];

'branding' => [
    // Application name shown on auth pages
    'app_name' => env('TYRO_LOGIN_APP_NAME', env('APP_NAME', 'Laravel')),

    // URL to your logo (null for text-based logo)
    'logo' => env('TYRO_LOGIN_LOGO', null),

    // Logo height for proper sizing
    'logo_height' => env('TYRO_LOGIN_LOGO_HEIGHT', '48px'),
],

TYRO_LOGIN_APP_NAME="My App"
TYRO_LOGIN_LOGO=https://myapp.com/logo.svg
TYRO_LOGIN_LOGO_HEIGHT=48px

'redirects' => [
    // Where to redirect after successful login
    'after_login' => env('TYRO_LOGIN_REDIRECT_AFTER_LOGIN', '/'),

    // Where to redirect after logout
    'after_logout' => env('TYRO_LOGIN_REDIRECT_AFTER_LOGOUT', '/login'),

    // Where to redirect after successful registration
    'after_register' => env('TYRO_LOGIN_REDIRECT_AFTER_REGISTER', '/'),

    // Where to redirect after email verification
    'after_email_verification' => env('TYRO_LOGIN_REDIRECT_AFTER_EMAIL_VERIFICATION', '/login'),
],

'registration' => [
    // Enable or disable user registration
    'enabled' => env('TYRO_LOGIN_REGISTRATION_ENABLED', true),

    // Automatically log in users after registration
    'auto_login' => env('TYRO_LOGIN_REGISTRATION_AUTO_LOGIN', true),

    // Require email verification (needs Laravel's email verification)
    'require_email_verification' => env('TYRO_LOGIN_REQUIRE_EMAIL_VERIFICATION', false),
],

php artisan tyro-login:install --with-social

composer require laravel/socialite
php artisan vendor:publish --tag=tyro-login-migrations
php artisan migrate

# Enable social login globally
TYRO_LOGIN_SOCIAL_ENABLED=true

# Enable specific providers
TYRO_LOGIN_SOCIAL_GOOGLE=true
TYRO_LOGIN_SOCIAL_GITHUB=true
TYRO_LOGIN_SOCIAL_FACEBOOK=true
TYRO_LOGIN_SOCIAL_TWITTER=true
TYRO_LOGIN_SOCIAL_LINKEDIN=true
TYRO_LOGIN_SOCIAL_BITBUCKET=true
TYRO_LOGIN_SOCIAL_GITLAB=true
TYRO_LOGIN_SOCIAL_SLACK=true

# Behavior settings
TYRO_LOGIN_SOCIAL_LINK_EXISTING=true    # Link to existing accounts by email
TYRO_LOGIN_SOCIAL_AUTO_REGISTER=true    # Create new users from social login
TYRO_LOGIN_SOCIAL_AUTO_VERIFY_EMAIL=true # Auto-verify email after social login

'google' => [
    'client_id' => env('GOOGLE_CLIENT_ID'),
    'client_secret' => env('GOOGLE_CLIENT_SECRET'),
    'redirect' => env('GOOGLE_REDIRECT_URI'),
],

'github' => [
    'client_id' => env('GITHUB_CLIENT_ID'),
    'client_secret' => env('GITHUB_CLIENT_SECRET'),
    'redirect' => env('GITHUB_REDIRECT_URI'),
],

'facebook' => [
    'client_id' => env('FACEBOOK_CLIENT_ID'),
    'client_secret' => env('FACEBOOK_CLIENT_SECRET'),
    'redirect' => env('FACEBOOK_REDIRECT_URI'),
],

# Google
GOOGLE_CLIENT_ID=your-client-id
GOOGLE_CLIENT_SECRET=your-client-secret
GOOGLE_REDIRECT_URI="${APP_URL}/auth/google/callback"

# GitHub
GITHUB_CLIENT_ID=your-client-id
GITHUB_CLIENT_SECRET=your-client-secret
GITHUB_REDIRECT_URI="${APP_URL}/auth/github/callback"

# Facebook
FACEBOOK_CLIENT_ID=your-client-id
FACEBOOK_CLIENT_SECRET=your-client-secret
FACEBOOK_REDIRECT_URI="${APP_URL}/auth/facebook/callback"

'captcha' => [
    // Enable captcha on login form
    'enabled_login' => env('TYRO_LOGIN_CAPTCHA_LOGIN', false),

    // Enable captcha on registration form
    'enabled_register' => env('TYRO_LOGIN_CAPTCHA_REGISTER', false),

    // Label shown above the captcha input
    'label' => 'Security Check',

    // Placeholder text for the input
    'placeholder' => 'Enter the answer',

    // Error message when answer is incorrect
    'error_message' => 'Incorrect answer. Please try again.',

    // Number range for the math problem
    'min_number' => 1,
    'max_number' => 10,
],

# Enable captcha on login form
TYRO_LOGIN_CAPTCHA_LOGIN=true

# Enable captcha on registration form
TYRO_LOGIN_CAPTCHA_REGISTER=true

'otp' => [
    // Enable OTP verification
    'enabled' => env('TYRO_LOGIN_OTP_ENABLED', false),

    // Number of digits (4-8)
    'length' => env('TYRO_LOGIN_OTP_LENGTH', 4),

    // OTP expiration time in minutes
    'expire' => env('TYRO_LOGIN_OTP_EXPIRE', 5),

    // Maximum resend attempts
    'max_resend' => env('TYRO_LOGIN_OTP_MAX_RESEND', 3),

    // Cooldown between resends in seconds
    'resend_cooldown' => env('TYRO_LOGIN_OTP_RESEND_COOLDOWN', 60),

    // UI Labels
    'title' => 'Enter Verification Code',
    'subtitle' => 'We\'ve sent a verification code to your email address.',
    'label' => 'Enter the :length-digit code',
    'submit_button' => 'Verify',
    'resend_button' => 'Resend Code',
    'cancel_button' => 'Cancel',
    'expire_message' => 'Code expires in :minutes minute(s)',
    'error_invalid' => 'Invalid verification code. Please try again.',
    'error_expired' => 'The verification code has expired. Please request a new one.',
    'success_resend' => 'A new verification code has been sent to your email.',
],

php artisan migrate

use HasinHayder\TyroLogin\Traits\HasTwoFactorAuth;

class User extends Authenticatable
{
    use HasTwoFactorAuth;
}

'two_factor' => [
    // Enable/disable 2FA globally
    'enabled' => env('TYRO_LOGIN_2FA_ENABLED', false),

    // Page titles and subtitles
    'setup_title' => env('TYRO_LOGIN_2FA_SETUP_TITLE', 'Two Factor Authentication'),
    'setup_subtitle' => env('TYRO_LOGIN_2FA_SETUP_SUBTITLE', 'Scan the QR code with your authenticator app.'),
    'challenge_title' => env('TYRO_LOGIN_2FA_CHALLENGE_TITLE', 'Two Factor Authentication'),
    'challenge_subtitle' => env('TYRO_LOGIN_2FA_CHALLENGE_SUBTITLE', 'Enter the code from your authenticator app.'),
    
    // Allow users to skip setup (if false, setup is mandatory)
    'allow_skip' => env('TYRO_LOGIN_2FA_ALLOW_SKIP', false),
],

# Reset 2FA by email
php artisan tyro-login:reset-2fa user@example.com

# Reset 2FA by user ID
php artisan tyro-login:reset-2fa 1

# Enable Time-Based 2FA
TYRO_LOGIN_2FA_ENABLED=true

# Allow users to skip 2FA setup (false = mandatory for all users)
TYRO_LOGIN_2FA_ALLOW_SKIP=false

# Customize page titles
TYRO_LOGIN_2FA_SETUP_TITLE="Two Factor Authentication"
TYRO_LOGIN_2FA_SETUP_SUBTITLE="Scan the QR code with your authenticator app."
TYRO_LOGIN_2FA_CHALLENGE_TITLE="Two Factor Authentication"
TYRO_LOGIN_2FA_CHALLENGE_SUBTITLE="Enter the code from your authenticator app."

'registration' => [
    // Require email verification after registration
    'require_email_verification' => env('TYRO_LOGIN_REQUIRE_EMAIL_VERIFICATION', true),
],

'verification' => [
    // Token expiration time in minutes
    'expire' => env('TYRO_LOGIN_VERIFICATION_EXPIRE', 60),
],

'redirects' => [
    // Where to redirect after email verification (default: login page)
    'after_email_verification' => env('TYRO_LOGIN_REDIRECT_AFTER_EMAIL_VERIFICATION', '/login'),
],

# Enable email verification
TYRO_LOGIN_REQUIRE_EMAIL_VERIFICATION=true

# Token expiration time in minutes
TYRO_LOGIN_VERIFICATION_EXPIRE=60

# Where to redirect after verification (default: /login)
TYRO_LOGIN_REDIRECT_AFTER_EMAIL_VERIFICATION=/login

'password_reset' => [
    // Token expiration time in minutes
    'expire' => env('TYRO_LOGIN_PASSWORD_RESET_EXPIRE', 60),
],

'features' => [
    // Show "Forgot Password" link on login form
    'forgot_password' => env('TYRO_LOGIN_FORGOT_PASSWORD', true),
],

# Show forgot password link
TYRO_LOGIN_FORGOT_PASSWORD=true

# Token expiration time in minutes
TYRO_LOGIN_PASSWORD_RESET_EXPIRE=60

'emails' => [
    // OTP verification email
    'otp' => [
        'enabled' => env('TYRO_LOGIN_EMAIL_OTP', true),
        'subject' => env('TYRO_LOGIN_EMAIL_OTP_SUBJECT', 'Your Verification Code'),
    ],

    // Password reset email
    'password_reset' => [
        'enabled' => env('TYRO_LOGIN_EMAIL_PASSWORD_RESET', true),
        'subject' => env('TYRO_LOGIN_EMAIL_PASSWORD_RESET_SUBJECT', 'Reset Your Password'),
    ],

    // Email verification email
    'verify_email' => [
        'enabled' => env('TYRO_LOGIN_EMAIL_VERIFY', true),
        'subject' => env('TYRO_LOGIN_EMAIL_VERIFY_SUBJECT', 'Verify Your Email Address'),
    ],

    // Welcome email after registration
    'welcome' => [
        'enabled' => env('TYRO_LOGIN_EMAIL_WELCOME', true),
        'subject' => env('TYRO_LOGIN_EMAIL_WELCOME_SUBJECT', null), // Uses default
    ],
],

php artisan tyro-login:publish --emails

# Enable/disable specific emails
TYRO_LOGIN_EMAIL_OTP=true
TYRO_LOGIN_EMAIL_PASSWORD_RESET=true
TYRO_LOGIN_EMAIL_VERIFY=true
TYRO_LOGIN_EMAIL_WELCOME=true

# Customize email subjects
TYRO_LOGIN_EMAIL_OTP_SUBJECT="Your Login Code"
TYRO_LOGIN_EMAIL_PASSWORD_RESET_SUBJECT="Reset Your Password"
TYRO_LOGIN_EMAIL_VERIFY_SUBJECT="Verify Your Email"

'lockout' => [
    // Enable or disable lockout protection
    'enabled' => env('TYRO_LOGIN_LOCKOUT_ENABLED', true),

    // Maximum login attempts before lockout
    'max_attempts' => env('TYRO_LOGIN_LOCKOUT_MAX_ATTEMPTS', 5),

    // Lockout duration in minutes
    'duration_minutes' => env('TYRO_LOGIN_LOCKOUT_DURATION', 15),

    // Custom lockout message (use :minutes placeholder)
    'message' => 'Too many failed login attempts. Please try again in :minutes minutes.',

    // Title shown on the lockout page
    'title' => 'Account Temporarily Locked',

    // Subtitle shown on the lockout page
    'subtitle' => 'For your security, we\'ve temporarily locked your account.',
],

// Enable debug logging
'debug' => env('TYRO_LOGIN_DEBUG', false),

# Enable debug logging (NEVER in production!)
TYRO_LOGIN_DEBUG=true

'tyro' => [
    // Assign default role to new users (requires Tyro package)
    'assign_default_role' => env('TYRO_LOGIN_ASSIGN_DEFAULT_ROLE', true),

    // The role slug to assign
    'default_role_slug' => env('TYRO_LOGIN_DEFAULT_ROLE_SLUG', 'user'),
],

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use HasinHayder\Tyro\Concerns\HasTyroRoles;

class User extends Authenticatable
{
    use HasTyroRoles;

    // ... rest of your model
}

php artisan tyro-login:publish --views

php artisan tyro-login:publish

# Publish only theme variables (recommended for color customization)
php artisan tyro-login:publish-style --theme-only

# Or publish complete styles (theme + component styles)
php artisan tyro-login:publish-style

resources/views/vendor/tyro-login/partials/
├── shadcn-theme.blade.php  # Theme variables (edit this!)
└── styles.blade.php        # Component styles (includes theme)

# Basic installation
php artisan tyro-login:install

# Install with social login support
php artisan tyro-login:install --with-social

# Force overwrite existing files
php artisan tyro-login:install --force

# Publish everything (default behavior)
php artisan tyro-login:publish

# Publish only configuration
php artisan tyro-login:publish --config

# Publish only views
php artisan tyro-login:publish --views

# Publish only email templates
php artisan tyro-login:publish --emails

# Publish only assets
php artisan tyro-login:publish --assets

# Force overwrite existing files
php artisan tyro-login:publish --force

# Publish both themes and shadcn components
php artisan tyro-login:publish-style

# Publish only theme variables
php artisan tyro-login:publish-style --theme-only

# Verify a single user by email
php artisan tyro-login:verify-user john@example.com

# Verify a single user by ID
php artisan tyro-login:verify-user 123

# Verify all unverified users
php artisan tyro-login:verify-user --all

# Unverify a single user by email
php artisan tyro-login:unverify-user john@example.com

# Unverify all verified users (use with caution!)
php artisan tyro-login:unverify-user --all