blueprints.yaml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. name: Login
  2. version: 2.5.0
  3. description: Enables user authentication and login screen.
  4. icon: sign-in
  5. author:
  6. name: Team Grav
  7. email: devs@getgrav.org
  8. url: http://getgrav.org
  9. keywords: admin, plugin, login
  10. homepage: https://github.com/getgrav/grav-plugin-login
  11. keywords: login, authentication, admin, security
  12. bugs: https://github.com/getgrav/grav-plugin-login/issues
  13. license: MIT
  14. dependencies:
  15. - { name: grav, version: '>=1.3.9' }
  16. - { name: form, version: '>=2.4.0' }
  17. - { name: email, version: '~2.0' }
  18. form:
  19. validation: loose
  20. fields:
  21. tabs:
  22. type: tabs
  23. active: 1
  24. class: subtle
  25. fields:
  26. login:
  27. type: tab
  28. title: PLUGIN_LOGIN.BTN_LOGIN
  29. fields:
  30. enabled:
  31. type: hidden
  32. label: PLUGIN_LOGIN.PLUGIN_STATUS
  33. highlight: 1
  34. default: 1
  35. options:
  36. 1: PLUGIN_ADMIN.ENABLED
  37. 0: PLUGIN_ADMIN.DISABLED
  38. validate:
  39. type: bool
  40. built_in_css:
  41. type: toggle
  42. label: PLUGIN_LOGIN.BUILTIN_CSS
  43. highlight: 1
  44. default: 1
  45. help: PLUGIN_LOGIN.BUILTIN_CSS_HELP
  46. options:
  47. 1: PLUGIN_ADMIN.ENABLED
  48. 0: PLUGIN_ADMIN.DISABLED
  49. validate:
  50. type: bool
  51. route:
  52. type: text
  53. size: medium
  54. label: PLUGIN_LOGIN.ROUTE
  55. help: PLUGIN_LOGIN.ROUTE_HELP
  56. placeholder: "/my-custom-login"
  57. redirect_after_login:
  58. type: text
  59. label: PLUGIN_LOGIN.REDIRECT_AFTER_LOGIN
  60. help: PLUGIN_LOGIN.REDIRECT_AFTER_LOGIN_HELP
  61. placeholder: "/my-page"
  62. route_forgot:
  63. type: text
  64. size: medium
  65. label: PLUGIN_LOGIN.ROUTE_FORGOT
  66. placeholder: "/forgot_password"
  67. route_reset:
  68. type: text
  69. size: medium
  70. label: PLUGIN_LOGIN.ROUTE_RESET
  71. placeholder: "/reset_password"
  72. route_profile:
  73. type: text
  74. size: medium
  75. label: PLUGIN_LOGIN.ROUTE_PROFILE
  76. placeholder: "/user_profile"
  77. parent_acl:
  78. type: toggle
  79. label: PLUGIN_LOGIN.USE_PARENT_ACL_LABEL
  80. highlight: 1
  81. default: 0
  82. help: PLUGIN_LOGIN.USE_PARENT_ACL_HELP
  83. options:
  84. 1: PLUGIN_ADMIN.ENABLED
  85. 0: PLUGIN_ADMIN.DISABLED
  86. validate:
  87. type: bool
  88. dynamic_page_visibility:
  89. type: toggle
  90. label: PLUGIN_LOGIN.DYNAMIC_VISIBILITY
  91. highlight: 0
  92. default: 0
  93. help: PLUGIN_LOGIN.DYNAMIC_VISIBILITY_HELP
  94. options:
  95. 1: PLUGIN_ADMIN.ENABLED
  96. 0: PLUGIN_ADMIN.DISABLED
  97. validate:
  98. type: bool
  99. protect_protected_page_media:
  100. type: toggle
  101. label: PLUGIN_LOGIN.PROTECT_PROTECTED_PAGE_MEDIA_LABEL
  102. highlight: 1
  103. default: 0
  104. help: PLUGIN_LOGIN.PROTECT_PROTECTED_PAGE_MEDIA_HELP
  105. options:
  106. 1: PLUGIN_ADMIN.ENABLED
  107. 0: PLUGIN_ADMIN.DISABLED
  108. validate:
  109. type: bool
  110. routes:
  111. type: section
  112. title: PLUGIN_LOGIN.ROUTES
  113. fields:
  114. route_activate:
  115. type: text
  116. size: medium
  117. label: PLUGIN_LOGIN.ROUTE_ACTIVATE
  118. placeholder: '/activate_user'
  119. route_forgot:
  120. type: text
  121. size: medium
  122. label: PLUGIN_LOGIN.ROUTE_FORGOT
  123. placeholder: '/forgot_password'
  124. route_reset:
  125. type: text
  126. size: medium
  127. label: PLUGIN_LOGIN.ROUTE_RESET
  128. placeholder: '/reset_password'
  129. route_profile:
  130. type: text
  131. size: medium
  132. label: PLUGIN_LOGIN.ROUTE_PROFILE
  133. placeholder: '/user_profile'
  134. route_register:
  135. type: text
  136. size: medium
  137. label: PLUGIN_LOGIN.ROUTE_REGISTER
  138. help: PLUGIN_LOGIN.ROUTE_REGISTER_HELP
  139. placeholder: "/register"
  140. user_registration.redirect_after_registration:
  141. type: text
  142. label: PLUGIN_LOGIN.REDIRECT_AFTER_REGISTRATION
  143. help: PLUGIN_LOGIN.REDIRECT_AFTER_REGISTRATION_HELP
  144. placeholder: "/page-to-show-after-registration"
  145. user_registration.redirect_after_activation:
  146. type: text
  147. label: PLUGIN_LOGIN.REDIRECT_AFTER_ACTIVATION
  148. help: PLUGIN_LOGIN.REDIRECT_AFTER_ACTIVATION_HELP
  149. placeholder: "/page-to-show-after-activation"
  150. rememberme:
  151. type: section
  152. title: PLUGIN_LOGIN.REMEMBER_ME
  153. fields:
  154. rememberme.enabled:
  155. type: toggle
  156. label: PLUGIN_ADMIN.ENABLED
  157. help: PLUGIN_ADMIN.SESSION_ENABLED_HELP
  158. highlight: 1
  159. options:
  160. 1: PLUGIN_ADMIN.YES
  161. 0: PLUGIN_ADMIN.NO
  162. validate:
  163. type: bool
  164. rememberme.timeout:
  165. type: text
  166. size: small
  167. default: 604800
  168. label: PLUGIN_ADMIN.TIMEOUT
  169. help: PLUGIN_LOGIN.TIMEOUT_HELP
  170. validate:
  171. type: number
  172. min: 1
  173. rememberme.name:
  174. type: text
  175. size: small
  176. label: PLUGIN_ADMIN.NAME
  177. help: PLUGIN_ADMIN.SESSION_NAME_HELP
  178. registration:
  179. type: tab
  180. title: PLUGIN_LOGIN.USER_REGISTRATION
  181. fields:
  182. user_registration.enabled:
  183. type: toggle
  184. label: PLUGIN_ADMIN.ENABLED
  185. help: PLUGIN_LOGIN.USER_REGISTRATION_ENABLED_HELP
  186. highlight: 1
  187. options:
  188. 1: PLUGIN_ADMIN.YES
  189. 0: PLUGIN_ADMIN.NO
  190. validate:
  191. type: bool
  192. registration_fields:
  193. type: section
  194. title: PLUGIN_LOGIN.REGISTRATION_FIELDS
  195. fields:
  196. user_registration.fields:
  197. type: array
  198. value_only: true
  199. label: PLUGIN_LOGIN.REGISTRATION_FIELDS
  200. help: PLUGIN_LOGIN.REGISTRATION_FIELDS_HELP
  201. placeholder_key: PLUGIN_LOGIN.REGISTRATION_FIELD_KEY
  202. placeholder_value: PLUGIN_LOGIN.REGISTRATION_FIELD_VALUE
  203. user_registration.default_values:
  204. type: array
  205. label: PLUGIN_LOGIN.DEFAULT_VALUES
  206. help: PLUGIN_LOGIN.DEFAULT_VALUES_HELP
  207. placeholder_key: PLUGIN_LOGIN.ADDITIONAL_PARAM_KEY
  208. placeholder_value: PLUGIN_LOGIN.ADDITIONAL_PARAM_VALUE
  209. access_levels:
  210. title: PLUGIN_ADMIN.ACCESS_LEVELS
  211. type: section
  212. security: admin.super
  213. fields:
  214. user_registration.groups:
  215. type: selectize
  216. size: large
  217. label: PLUGIN_ADMIN.GROUPS
  218. '@data-options': '\Grav\User\Groups::groups'
  219. classes: fancy
  220. help: PLUGIN_LOGIN.GROUPS_HELP
  221. validate:
  222. type: commalist
  223. user_registration.access.site:
  224. type: array
  225. label: PLUGIN_ADMIN.SITE_ACCESS
  226. help: PLUGIN_LOGIN.SITE_ACCESS_HELP
  227. multiple: false
  228. validate:
  229. type: array
  230. options:
  231. type: section
  232. title: PLUGIN_LOGIN.OPTIONS
  233. fields:
  234. user_registration.options.validate_password1_and_password2:
  235. type: toggle
  236. label: PLUGIN_LOGIN.VALIDATE_PASSWORD1_AND_PASSWORD2
  237. help: PLUGIN_LOGIN.VALIDATE_PASSWORD1_AND_PASSWORD2_HELP
  238. highlight: 1
  239. options:
  240. 1: PLUGIN_ADMIN.YES
  241. 0: PLUGIN_ADMIN.NO
  242. validate:
  243. type: bool
  244. user_registration.options.set_user_disabled:
  245. type: toggle
  246. label: PLUGIN_LOGIN.SET_USER_DISABLED
  247. help: PLUGIN_LOGIN.SET_USER_DISABLED_HELP
  248. highlight: 1
  249. options:
  250. 1: PLUGIN_ADMIN.YES
  251. 0: PLUGIN_ADMIN.NO
  252. validate:
  253. type: bool
  254. user_registration.options.login_after_registration:
  255. type: toggle
  256. label: PLUGIN_LOGIN.LOGIN_AFTER_REGISTRATION
  257. help: PLUGIN_LOGIN.LOGIN_AFTER_REGISTRATION_HELP
  258. highlight: 1
  259. options:
  260. 1: PLUGIN_ADMIN.YES
  261. 0: PLUGIN_ADMIN.NO
  262. validate:
  263. type: bool
  264. user_registration.options.send_activation_email:
  265. type: toggle
  266. label: PLUGIN_LOGIN.SEND_ACTIVATION_EMAIL
  267. help: PLUGIN_LOGIN.SEND_ACTIVATION_EMAIL_HELP
  268. highlight: 1
  269. options:
  270. 1: PLUGIN_ADMIN.YES
  271. 0: PLUGIN_ADMIN.NO
  272. validate:
  273. type: bool
  274. user_registration.options.send_notification_email:
  275. type: toggle
  276. label: PLUGIN_LOGIN.SEND_NOTIFICATION_EMAIL
  277. help: PLUGIN_LOGIN.SEND_NOTIFICATION_EMAIL_HELP
  278. highlight: 1
  279. options:
  280. 1: PLUGIN_ADMIN.YES
  281. 0: PLUGIN_ADMIN.NO
  282. validate:
  283. type: bool
  284. user_registration.options.send_welcome_email:
  285. type: toggle
  286. label: PLUGIN_LOGIN.SEND_WELCOME_EMAIL
  287. help: PLUGIN_LOGIN.SEND_WELCOME_EMAIL_HELP
  288. highlight: 1
  289. options:
  290. 1: PLUGIN_ADMIN.YES
  291. 0: PLUGIN_ADMIN.NO
  292. Security:
  293. type: tab
  294. title: PLUGIN_LOGIN.SECURITY_TAB
  295. fields:
  296. max_pw_resets_count:
  297. type: number
  298. size: x-small
  299. label: PLUGIN_LOGIN.MAX_RESETS_COUNT
  300. help: PLUGIN_LOGIN.MAX_RESETS_COUNT_HELP
  301. append: PLUGIN_LOGIN.RESETS
  302. validate:
  303. type: number
  304. min: 0
  305. max_pw_resets_interval:
  306. type: number
  307. size: x-small
  308. label: PLUGIN_LOGIN.MAX_RESETS_INTERVAL
  309. help: PLUGIN_LOGIN.MAX_RESETS_INTERVAL_HELP
  310. append: PLUGIN_LOGIN.SECONDS
  311. validate:
  312. type: number
  313. min: 1
  314. max_login_count:
  315. type: number
  316. size: x-small
  317. label: PLUGIN_LOGIN.MAX_LOGINS_COUNT
  318. help: PLUGIN_LOGIN.MAX_LOGINS_COUNT_HELP
  319. append: PLUGIN_LOGIN.ATTEMPTS
  320. validate:
  321. type: number
  322. min: 0
  323. max_login_interval:
  324. type: number
  325. size: x-small
  326. label: PLUGIN_LOGIN.MAX_LOGINS_INTERVAL
  327. help: PLUGIN_LOGIN.MAX_LOGINS_INTERVAL_HELP
  328. append: PLUGIN_LOGIN.SECONDS
  329. validate:
  330. type: number
  331. min: 1