login.yaml 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. enabled: true # Enable the plugin
  2. built_in_css: true # Use built-in CSS
  3. route: # Specific route for Login page (default is '/login')
  4. redirect_to_login: true # If you try to access a page you don't have access to, should you redirect to login route
  5. redirect_after_login: # Path to redirect to after a successful login (eg '/user_profile')
  6. route_activate: '/activate_user' # Route for the user activation process
  7. route_forgot: '/forgot_password' # Route for the forgot password process
  8. route_reset: '/reset_password' # Route for the reset password process
  9. route_profile: '/user_profile' # Route for the user profile page
  10. route_register: '/user_register' # Route for the user registration page
  11. route_unauthorized: '/user_unauthorized' # Route for a page to display if user is unauthorized
  12. dynamic_page_visibility: false # Integrate access into page visibility so things can be shown or hidden in the menu
  13. parent_acl: false # Look to parent `access` rules for access requirements
  14. protect_protected_page_media: false # Take `access` rules into account when directly accessing a page's media
  15. rememberme:
  16. enabled: true # Enable 'remember me' functionality
  17. timeout: 604800 # Timeout in seconds. Defaults to 1 week
  18. name: grav-rememberme # Name prefix of the session cookie
  19. max_pw_resets_count: 0 # Number of password resets in a specific time frame (0 = unlimited)
  20. max_pw_resets_interval: 60 # Time in minutes to track password resets
  21. max_login_count: 0 # Number of failed login attempts in a specific time frame (0 = unlimited)
  22. max_login_interval: 2 # Time in minutes to track login attempts
  23. user_registration:
  24. enabled: true # Enable User Registration Process
  25. fields: # List of fields to validate and store during user registration
  26. - 'username' # This should match up with your registration form definition
  27. - 'password'
  28. - 'email'
  29. - 'fullname'
  30. - 'title'
  31. - 'level'
  32. default_values: # Any default values for fields you would like to set
  33. level: Newbie # Here the 'level' field will be pre-populated with 'Newbie' text
  34. access: # Default access to set for users created during registration
  35. site:
  36. login: 'true'
  37. redirect_after_registration: '' # Route to redirect to after registration
  38. options:
  39. validate_password1_and_password2: true # Ensure that password1 and password2 match during registration (allows you to have just 1 pw field or 2)
  40. set_user_disabled: false # Set this `true` if you want a user to activate their account via email
  41. login_after_registration: true # Automatically login after registration
  42. send_activation_email: false # Send an email that requires a special link to be clicked in order to activate the account
  43. send_notification_email: false # Send an email to the site administrator to indicate a user has registered
  44. send_welcome_email: false # Send a welcome email to the user (probably should not be used with `send_activation_email`