blueprints.yaml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. name: Login
  2. version: 3.0.3
  3. testing: false
  4. description: Enables user authentication and login screen.
  5. icon: sign-in
  6. author:
  7. name: Team Grav
  8. email: devs@getgrav.org
  9. url: http://getgrav.org
  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.6.7' }
  16. - { name: form, version: '>=3.0.0' }
  17. - { name: email, version: '>=3.0.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. redirect_after_logout:
  63. type: text
  64. label: PLUGIN_LOGIN.REDIRECT_AFTER_LOGOUT
  65. help: PLUGIN_LOGIN.REDIRECT_AFTER_LOGOUT_HELP
  66. placeholder: "/"
  67. route_forgot:
  68. type: text
  69. size: medium
  70. label: PLUGIN_LOGIN.ROUTE_FORGOT
  71. placeholder: "/forgot_password"
  72. route_reset:
  73. type: text
  74. size: medium
  75. label: PLUGIN_LOGIN.ROUTE_RESET
  76. placeholder: "/reset_password"
  77. route_profile:
  78. type: text
  79. size: medium
  80. label: PLUGIN_LOGIN.ROUTE_PROFILE
  81. placeholder: "/user_profile"
  82. parent_acl:
  83. type: toggle
  84. label: PLUGIN_LOGIN.USE_PARENT_ACL_LABEL
  85. highlight: 1
  86. default: 0
  87. help: PLUGIN_LOGIN.USE_PARENT_ACL_HELP
  88. options:
  89. 1: PLUGIN_ADMIN.ENABLED
  90. 0: PLUGIN_ADMIN.DISABLED
  91. validate:
  92. type: bool
  93. dynamic_page_visibility:
  94. type: toggle
  95. label: PLUGIN_LOGIN.DYNAMIC_VISIBILITY
  96. highlight: 0
  97. default: 0
  98. help: PLUGIN_LOGIN.DYNAMIC_VISIBILITY_HELP
  99. options:
  100. 1: PLUGIN_ADMIN.ENABLED
  101. 0: PLUGIN_ADMIN.DISABLED
  102. validate:
  103. type: bool
  104. twofa_enabled:
  105. type: toggle
  106. label: PLUGIN_LOGIN.2FA_ENABLED
  107. highlight: 0
  108. default: 0
  109. help: PLUGIN_LOGIN.2FA_ENABLED_HELP
  110. options:
  111. 1: PLUGIN_ADMIN.ENABLED
  112. 0: PLUGIN_ADMIN.DISABLED
  113. validate:
  114. type: bool
  115. protect_protected_page_media:
  116. type: toggle
  117. label: PLUGIN_LOGIN.PROTECT_PROTECTED_PAGE_MEDIA_LABEL
  118. highlight: 1
  119. default: 0
  120. help: PLUGIN_LOGIN.PROTECT_PROTECTED_PAGE_MEDIA_HELP
  121. options:
  122. 1: PLUGIN_ADMIN.ENABLED
  123. 0: PLUGIN_ADMIN.DISABLED
  124. validate:
  125. type: bool
  126. routes:
  127. type: section
  128. title: PLUGIN_LOGIN.ROUTES
  129. fields:
  130. route_activate:
  131. type: text
  132. size: medium
  133. label: PLUGIN_LOGIN.ROUTE_ACTIVATE
  134. placeholder: '/activate_user'
  135. route_forgot:
  136. type: text
  137. size: medium
  138. label: PLUGIN_LOGIN.ROUTE_FORGOT
  139. placeholder: '/forgot_password'
  140. route_reset:
  141. type: text
  142. size: medium
  143. label: PLUGIN_LOGIN.ROUTE_RESET
  144. placeholder: '/reset_password'
  145. route_profile:
  146. type: text
  147. size: medium
  148. label: PLUGIN_LOGIN.ROUTE_PROFILE
  149. placeholder: '/user_profile'
  150. route_register:
  151. type: text
  152. size: medium
  153. label: PLUGIN_LOGIN.ROUTE_REGISTER
  154. help: PLUGIN_LOGIN.ROUTE_REGISTER_HELP
  155. placeholder: "/register"
  156. user_registration.redirect_after_registration:
  157. type: text
  158. label: PLUGIN_LOGIN.REDIRECT_AFTER_REGISTRATION
  159. help: PLUGIN_LOGIN.REDIRECT_AFTER_REGISTRATION_HELP
  160. placeholder: "/page-to-show-after-registration"
  161. user_registration.redirect_after_activation:
  162. type: text
  163. label: PLUGIN_LOGIN.REDIRECT_AFTER_ACTIVATION
  164. help: PLUGIN_LOGIN.REDIRECT_AFTER_ACTIVATION_HELP
  165. placeholder: "/page-to-show-after-activation"
  166. rememberme:
  167. type: section
  168. title: PLUGIN_LOGIN.REMEMBER_ME
  169. fields:
  170. rememberme.enabled:
  171. type: toggle
  172. label: PLUGIN_ADMIN.ENABLED
  173. help: PLUGIN_ADMIN.SESSION_ENABLED_HELP
  174. highlight: 1
  175. options:
  176. 1: PLUGIN_ADMIN.YES
  177. 0: PLUGIN_ADMIN.NO
  178. validate:
  179. type: bool
  180. rememberme.timeout:
  181. type: text
  182. size: small
  183. default: 604800
  184. label: PLUGIN_ADMIN.TIMEOUT
  185. help: PLUGIN_LOGIN.TIMEOUT_HELP
  186. validate:
  187. type: number
  188. min: 1
  189. rememberme.name:
  190. type: text
  191. size: small
  192. label: PLUGIN_ADMIN.NAME
  193. help: PLUGIN_ADMIN.SESSION_NAME_HELP
  194. registration:
  195. type: tab
  196. title: PLUGIN_LOGIN.USER_REGISTRATION
  197. fields:
  198. user_registration.enabled:
  199. type: toggle
  200. label: PLUGIN_ADMIN.ENABLED
  201. help: PLUGIN_LOGIN.USER_REGISTRATION_ENABLED_HELP
  202. highlight: 0
  203. options:
  204. 1: PLUGIN_ADMIN.YES
  205. 0: PLUGIN_ADMIN.NO
  206. validate:
  207. type: bool
  208. registration_fields:
  209. type: section
  210. title: PLUGIN_LOGIN.REGISTRATION_FIELDS
  211. fields:
  212. user_registration.fields:
  213. type: array
  214. value_only: true
  215. label: PLUGIN_LOGIN.REGISTRATION_FIELDS
  216. help: PLUGIN_LOGIN.REGISTRATION_FIELDS_HELP
  217. placeholder_key: PLUGIN_LOGIN.REGISTRATION_FIELD_KEY
  218. placeholder_value: PLUGIN_LOGIN.ADDITIONAL_PARAM_VALUE
  219. user_registration.default_values:
  220. type: array
  221. label: PLUGIN_LOGIN.DEFAULT_VALUES
  222. help: PLUGIN_LOGIN.DEFAULT_VALUES_HELP
  223. placeholder_key: PLUGIN_LOGIN.ADDITIONAL_PARAM_KEY
  224. placeholder_value: PLUGIN_LOGIN.ADDITIONAL_PARAM_VALUE
  225. access_levels:
  226. title: PLUGIN_ADMIN.ACCESS_LEVELS
  227. type: section
  228. security: admin.super
  229. fields:
  230. user_registration.groups:
  231. type: selectize
  232. size: large
  233. label: PLUGIN_ADMIN.GROUPS
  234. '@data-options': '\Grav\User\Groups::groups'
  235. classes: fancy
  236. help: PLUGIN_LOGIN.GROUPS_HELP
  237. validate:
  238. type: commalist
  239. user_registration.access.site:
  240. type: array
  241. label: PLUGIN_ADMIN.SITE_ACCESS
  242. help: PLUGIN_LOGIN.SITE_ACCESS_HELP
  243. multiple: false
  244. validate:
  245. type: array
  246. options:
  247. type: section
  248. title: PLUGIN_LOGIN.OPTIONS
  249. fields:
  250. user_registration.options.validate_password1_and_password2:
  251. type: toggle
  252. label: PLUGIN_LOGIN.VALIDATE_PASSWORD1_AND_PASSWORD2
  253. help: PLUGIN_LOGIN.VALIDATE_PASSWORD1_AND_PASSWORD2_HELP
  254. highlight: 1
  255. options:
  256. 1: PLUGIN_ADMIN.YES
  257. 0: PLUGIN_ADMIN.NO
  258. validate:
  259. type: bool
  260. user_registration.options.set_user_disabled:
  261. type: toggle
  262. label: PLUGIN_LOGIN.SET_USER_DISABLED
  263. help: PLUGIN_LOGIN.SET_USER_DISABLED_HELP
  264. highlight: 0
  265. options:
  266. 1: PLUGIN_ADMIN.YES
  267. 0: PLUGIN_ADMIN.NO
  268. validate:
  269. type: bool
  270. user_registration.options.login_after_registration:
  271. type: toggle
  272. label: PLUGIN_LOGIN.LOGIN_AFTER_REGISTRATION
  273. help: PLUGIN_LOGIN.LOGIN_AFTER_REGISTRATION_HELP
  274. highlight: 0
  275. options:
  276. 1: PLUGIN_ADMIN.YES
  277. 0: PLUGIN_ADMIN.NO
  278. validate:
  279. type: bool
  280. user_registration.options.send_activation_email:
  281. type: toggle
  282. label: PLUGIN_LOGIN.SEND_ACTIVATION_EMAIL
  283. help: PLUGIN_LOGIN.SEND_ACTIVATION_EMAIL_HELP
  284. highlight: 0
  285. options:
  286. 1: PLUGIN_ADMIN.YES
  287. 0: PLUGIN_ADMIN.NO
  288. validate:
  289. type: bool
  290. user_registration.options.manually_enable:
  291. type: toggle
  292. label: PLUGIN_LOGIN.MANUALLY_ENABLE
  293. help: PLUGIN_LOGIN.MANUALLY_ENABLE_HELP
  294. highlight: 0
  295. options:
  296. 1: PLUGIN_ADMIN.YES
  297. 0: PLUGIN_ADMIN.NO
  298. validate:
  299. type: bool
  300. user_registration.options.send_notification_email:
  301. type: toggle
  302. label: PLUGIN_LOGIN.SEND_NOTIFICATION_EMAIL
  303. help: PLUGIN_LOGIN.SEND_NOTIFICATION_EMAIL_HELP
  304. highlight: 0
  305. options:
  306. 1: PLUGIN_ADMIN.YES
  307. 0: PLUGIN_ADMIN.NO
  308. validate:
  309. type: bool
  310. user_registration.options.send_welcome_email:
  311. type: toggle
  312. label: PLUGIN_LOGIN.SEND_WELCOME_EMAIL
  313. help: PLUGIN_LOGIN.SEND_WELCOME_EMAIL_HELP
  314. highlight: 0
  315. options:
  316. 1: PLUGIN_ADMIN.YES
  317. 0: PLUGIN_ADMIN.NO
  318. validate:
  319. type: bool
  320. Security:
  321. type: tab
  322. title: PLUGIN_LOGIN.SECURITY_TAB
  323. fields:
  324. max_pw_resets_count:
  325. type: number
  326. size: x-small
  327. label: PLUGIN_LOGIN.MAX_RESETS_COUNT
  328. help: PLUGIN_LOGIN.MAX_RESETS_COUNT_HELP
  329. append: PLUGIN_LOGIN.RESETS
  330. validate:
  331. type: number
  332. min: 0
  333. max_pw_resets_interval:
  334. type: number
  335. size: x-small
  336. label: PLUGIN_LOGIN.MAX_RESETS_INTERVAL
  337. help: PLUGIN_LOGIN.MAX_RESETS_INTERVAL_HELP
  338. append: PLUGIN_LOGIN.MINUTES
  339. validate:
  340. type: number
  341. min: 1
  342. max_login_count:
  343. type: number
  344. size: x-small
  345. label: PLUGIN_LOGIN.MAX_LOGINS_COUNT
  346. help: PLUGIN_LOGIN.MAX_LOGINS_COUNT_HELP
  347. append: PLUGIN_LOGIN.ATTEMPTS
  348. validate:
  349. type: number
  350. min: 0
  351. max_login_interval:
  352. type: number
  353. size: x-small
  354. label: PLUGIN_LOGIN.MAX_LOGINS_INTERVAL
  355. help: PLUGIN_LOGIN.MAX_LOGINS_INTERVAL_HELP
  356. append: PLUGIN_LOGIN.MINUTES
  357. validate:
  358. type: number
  359. min: 1
  360. ipv6_subnet_size:
  361. type: number
  362. size: x-small
  363. label: PLUGIN_LOGIN.IPV6_SUBNET_SIZE
  364. help: PLUGIN_LOGIN.IPV6_SUBNET_SIZE_HELP
  365. append: PLUGIN_LOGIN.MINUTES
  366. validate:
  367. type: number
  368. min: 1