login.yaml 3.7 KB

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