blueprints.yaml 14 KB

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