blueprints.yaml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  1. name: Login
  2. slug: login
  3. type: plugin
  4. version: 3.3.5
  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.6.7' }
  18. - { name: form, version: '>=3.0.0' }
  19. - { name: email, version: '>=3.0.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. data-default@: '\Grav\Plugin\LoginPlugin::defaultRedirectAfterLogin'
  187. placeholder: "/user_profile"
  188. route_after_logout:
  189. type: text
  190. size: medium
  191. label: PLUGIN_LOGIN.ROUTE_AFTER_LOGOUT
  192. help: PLUGIN_LOGIN.ROUTE_AFTER_LOGOUT_HELP
  193. data-default@: '\Grav\Plugin\LoginPlugin::defaultRedirectAfterLogout'
  194. placeholder: "/"
  195. route_forgot:
  196. type: text
  197. size: medium
  198. label: PLUGIN_LOGIN.ROUTE_FORGOT
  199. placeholder: "/forgot_password"
  200. route_reset:
  201. type: text
  202. size: medium
  203. label: PLUGIN_LOGIN.ROUTE_RESET
  204. placeholder: "/reset_password"
  205. route_profile:
  206. type: text
  207. size: medium
  208. label: PLUGIN_LOGIN.ROUTE_PROFILE
  209. placeholder: "/user_profile"
  210. route_activate:
  211. type: text
  212. size: medium
  213. label: PLUGIN_LOGIN.ROUTE_ACTIVATE
  214. placeholder: '/activate_user'
  215. user_registration.redirect_after_activation:
  216. type: text
  217. size: medium
  218. label: PLUGIN_LOGIN.REDIRECT_AFTER_ACTIVATION
  219. help: PLUGIN_LOGIN.REDIRECT_AFTER_ACTIVATION_HELP
  220. placeholder: "/page-to-show-after-activation"
  221. route_register:
  222. type: text
  223. size: medium
  224. label: PLUGIN_LOGIN.ROUTE_REGISTER
  225. help: PLUGIN_LOGIN.ROUTE_REGISTER_HELP
  226. placeholder: "/register"
  227. user_registration.redirect_after_registration:
  228. type: text
  229. size: medium
  230. label: PLUGIN_LOGIN.REDIRECT_AFTER_REGISTRATION
  231. help: PLUGIN_LOGIN.REDIRECT_AFTER_REGISTRATION_HELP
  232. placeholder: "/page-to-show-after-registration"
  233. registration:
  234. type: tab
  235. title: PLUGIN_LOGIN.USER_REGISTRATION
  236. fields:
  237. user_registration.enabled:
  238. type: toggle
  239. label: PLUGIN_ADMIN.ENABLED
  240. help: PLUGIN_LOGIN.USER_REGISTRATION_ENABLED_HELP
  241. highlight: 0
  242. options:
  243. 1: PLUGIN_ADMIN.YES
  244. 0: PLUGIN_ADMIN.NO
  245. validate:
  246. type: bool
  247. registration_fields:
  248. type: section
  249. title: PLUGIN_LOGIN.REGISTRATION_FIELDS
  250. fields:
  251. user_registration.fields:
  252. type: array
  253. value_only: true
  254. label: PLUGIN_LOGIN.REGISTRATION_FIELDS
  255. help: PLUGIN_LOGIN.REGISTRATION_FIELDS_HELP
  256. placeholder_key: PLUGIN_LOGIN.REGISTRATION_FIELD_KEY
  257. placeholder_value: PLUGIN_LOGIN.ADDITIONAL_PARAM_VALUE
  258. user_registration.default_values:
  259. type: array
  260. label: PLUGIN_LOGIN.DEFAULT_VALUES
  261. help: PLUGIN_LOGIN.DEFAULT_VALUES_HELP
  262. placeholder_key: PLUGIN_LOGIN.ADDITIONAL_PARAM_KEY
  263. placeholder_value: PLUGIN_LOGIN.ADDITIONAL_PARAM_VALUE
  264. access_levels:
  265. title: PLUGIN_ADMIN.ACCESS_LEVELS
  266. type: section
  267. security: admin.super
  268. fields:
  269. user_registration.groups:
  270. type: select
  271. multiple: true
  272. size: large
  273. label: PLUGIN_ADMIN.GROUPS
  274. data-options@: '\Grav\Common\User\Group::groupNames'
  275. classes: fancy
  276. help: PLUGIN_LOGIN.GROUPS_HELP
  277. validate:
  278. type: commalist
  279. user_registration.access.site:
  280. type: array
  281. label: PLUGIN_ADMIN.SITE_ACCESS
  282. help: PLUGIN_LOGIN.SITE_ACCESS_HELP
  283. multiple: false
  284. validate:
  285. type: array
  286. options:
  287. type: section
  288. title: PLUGIN_LOGIN.OPTIONS
  289. fields:
  290. user_registration.options.validate_password1_and_password2:
  291. type: toggle
  292. label: PLUGIN_LOGIN.VALIDATE_PASSWORD1_AND_PASSWORD2
  293. help: PLUGIN_LOGIN.VALIDATE_PASSWORD1_AND_PASSWORD2_HELP
  294. highlight: 1
  295. options:
  296. 1: PLUGIN_ADMIN.YES
  297. 0: PLUGIN_ADMIN.NO
  298. validate:
  299. type: bool
  300. user_registration.options.set_user_disabled:
  301. type: toggle
  302. label: PLUGIN_LOGIN.SET_USER_DISABLED
  303. help: PLUGIN_LOGIN.SET_USER_DISABLED_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.login_after_registration:
  311. type: toggle
  312. label: PLUGIN_LOGIN.LOGIN_AFTER_REGISTRATION
  313. help: PLUGIN_LOGIN.LOGIN_AFTER_REGISTRATION_HELP
  314. highlight: 0
  315. options:
  316. 1: PLUGIN_ADMIN.YES
  317. 0: PLUGIN_ADMIN.NO
  318. validate:
  319. type: bool
  320. user_registration.options.send_activation_email:
  321. type: toggle
  322. label: PLUGIN_LOGIN.SEND_ACTIVATION_EMAIL
  323. help: PLUGIN_LOGIN.SEND_ACTIVATION_EMAIL_HELP
  324. highlight: 0
  325. options:
  326. 1: PLUGIN_ADMIN.YES
  327. 0: PLUGIN_ADMIN.NO
  328. validate:
  329. type: bool
  330. user_registration.options.manually_enable:
  331. type: toggle
  332. label: PLUGIN_LOGIN.MANUALLY_ENABLE
  333. help: PLUGIN_LOGIN.MANUALLY_ENABLE_HELP
  334. highlight: 0
  335. options:
  336. 1: PLUGIN_ADMIN.YES
  337. 0: PLUGIN_ADMIN.NO
  338. validate:
  339. type: bool
  340. user_registration.options.send_notification_email:
  341. type: toggle
  342. label: PLUGIN_LOGIN.SEND_NOTIFICATION_EMAIL
  343. help: PLUGIN_LOGIN.SEND_NOTIFICATION_EMAIL_HELP
  344. highlight: 0
  345. options:
  346. 1: PLUGIN_ADMIN.YES
  347. 0: PLUGIN_ADMIN.NO
  348. validate:
  349. type: bool
  350. user_registration.options.send_welcome_email:
  351. type: toggle
  352. label: PLUGIN_LOGIN.SEND_WELCOME_EMAIL
  353. help: PLUGIN_LOGIN.SEND_WELCOME_EMAIL_HELP
  354. highlight: 0
  355. options:
  356. 1: PLUGIN_ADMIN.YES
  357. 0: PLUGIN_ADMIN.NO
  358. validate:
  359. type: bool
  360. Security:
  361. type: tab
  362. title: PLUGIN_LOGIN.SECURITY_TAB
  363. fields:
  364. max_pw_resets_count:
  365. type: number
  366. size: x-small
  367. label: PLUGIN_LOGIN.MAX_RESETS_COUNT
  368. help: PLUGIN_LOGIN.MAX_RESETS_COUNT_HELP
  369. append: PLUGIN_LOGIN.RESETS
  370. validate:
  371. type: number
  372. min: 0
  373. max_pw_resets_interval:
  374. type: number
  375. size: x-small
  376. label: PLUGIN_LOGIN.MAX_RESETS_INTERVAL
  377. help: PLUGIN_LOGIN.MAX_RESETS_INTERVAL_HELP
  378. append: PLUGIN_LOGIN.MINUTES
  379. validate:
  380. type: number
  381. min: 1
  382. max_login_count:
  383. type: number
  384. size: x-small
  385. label: PLUGIN_LOGIN.MAX_LOGINS_COUNT
  386. help: PLUGIN_LOGIN.MAX_LOGINS_COUNT_HELP
  387. append: PLUGIN_LOGIN.ATTEMPTS
  388. validate:
  389. type: number
  390. min: 0
  391. max_login_interval:
  392. type: number
  393. size: x-small
  394. label: PLUGIN_LOGIN.MAX_LOGINS_INTERVAL
  395. help: PLUGIN_LOGIN.MAX_LOGINS_INTERVAL_HELP
  396. append: PLUGIN_LOGIN.MINUTES
  397. validate:
  398. type: number
  399. min: 1
  400. ipv6_subnet_size:
  401. type: number
  402. size: x-small
  403. label: PLUGIN_LOGIN.IPV6_SUBNET_SIZE
  404. help: PLUGIN_LOGIN.IPV6_SUBNET_SIZE_HELP
  405. append: PLUGIN_LOGIN.MINUTES
  406. validate:
  407. type: number
  408. min: 1