You are here

Home » API reference » Shield 8

shield.schema.yml in Shield 8

config/schema/shield.schema.yml

File

config/schema/shield.schema.yml
View source 
  1. # Schema for the configuration files of the shield module.

  2. 

  3. shield.settings:

  4.   type: config_object

  5.   label: 'Shield settings'

  6.   mapping:

  7.     shield_enable:

  8.       type: boolean

  9.       label: 'Enable shield'

  10.     credential_provider:

  11.       type: 'string'

  12.       label: 'Credential provider'

  13.     credentials:

  14.       type: sequence

  15.       label: 'Credentials'

  16.       sequence:

  17.         type: shield.credentials.[%key]

  18.     allow_cli:

  19.       type: boolean

  20.       label: 'CLI bypass'

  21.     print:

  22.       type: string

  23.       label: 'The greeting text, [user] and [pass] tokens are usable.'

  24.     whitelist:

  25.       type: string

  26.       label: 'Bypass shield based on user IP'

  27.     domains:

  28.       type: text

  29.       label: 'Bypass shield based on domain name'

  30. 

  31. shield.credentials.shield:

  32.   type: mapping

  33.   label: 'Shield credentials'

  34.   mapping:

  35.     user:

  36.       type: string

  37.       label: 'Username'

  38.     pass:

  39.       type: string

  40.       label: 'Password'

  41. 

  42. shield.credentials.key:

  43.   type: mapping

  44.   label: 'Shield credentials with Key Module'

  45.   mapping:

  46.     user:

  47.       type: string

  48.       label: 'Username'

  49.     pass_key:

  50.       type: string

  51.       label: 'Password key'

  52. 

  53. shield.credentials.multikey:

  54.   type: mapping

  55.   label: 'Shield credentials with Key Module (user/password keys)'

  56.   mapping:

  57.     user_pass_key:

  58.       type: string

  59.       label: 'User/Password key'