blueprints.yaml 13 KB

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