Skip to content

Settings ​

Settings live in YAML files. See Where settings live for the order. Most people only need the commands in Tell it what is sensitive.

Example .pii-airlock.yaml:

yaml
languages: [en, fr]
score_threshold: 0.5
entity_actions:
  SECRET: block
  IBAN_CODE: redact

Detection ​

SettingDefaultMeaning
languages[en, fr]Languages to analyse
modelsen_core_web_lg, fr_core_news_lgModel used per language
score_threshold0.5Minimum confidence. Lower catches more and flags more false positives.
score_thresholds{}Per-type minimum, for example {PERSON: 0.7}
entities[]Only these types. Empty means all.
exclude_entitiessee What it detectsTypes to skip
builtin_recognizerstrueUse the checked recognizers (IDs, phones, secrets)
ner_backendspacyspacy or gliner
allow_list[]Terms never treated as personal
deny_list{}Terms always sensitive, grouped by label
custom_patterns[]Your own regular expressions
entity_actions{}Per type: tokenize, redact, allow, block

Placeholders ​

SettingDefaultMeaning
token_stylestablestable, surrogate (realistic fakes) or sequential (numbered)
token_rotationdayday, week or never

See Placeholders explained.

Hooks ​

SettingDefaultMeaning
hook_decisionaskTool calls: ask or deny
prompt_decisionblockPrompts: block or warn
hook_on_errorclosedIf detection fails: closed treats input as sensitive, open skips the check
hook_max_file_bytes2000000Larger files count as a detection failure
hook_daemonautoKeep models loaded between calls. off disables it.
hook_daemon_idle_minutes30Stop the helper after this much idle time
hook_fallbackinprocessIf the helper is down: load models, or regex for fast pattern-only checks that do not find names or places

Gateway ​

SettingDefaultMeaning
passthrough_paths[]Path fragments forwarded without cleaning. Use only when you are sure they carry no personal data.
mapping_backendmemorymemory keeps nothing on disk. file stores mappings, encrypted.
mapping_dirFolder for the file backend
mapping_encryptiontrueSet false only for debugging
analysis_cache_size2048Texts remembered so repeated history is not re-analysed. 0 turns it off.

Full reference ​

The complete annotated file is config.default.yaml.

Released under the MIT License.