diff options
Diffstat (limited to 'docs/USER_RECORD.md')
| -rw-r--r-- | docs/USER_RECORD.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/USER_RECORD.md b/docs/USER_RECORD.md index aba45c39f4..50ea58ac31 100644 --- a/docs/USER_RECORD.md +++ b/docs/USER_RECORD.md @@ -914,6 +914,20 @@ itself. `fileSystemType` → The file system type backing the home directory: a short string, such as "btrfs", "ext4", "xfs". +`fallbackShell`, `fallbackHomeDirectory` → These fields have the same contents +and format as the `shell` and `homeDirectory` fields (see above). When the +`useFallback` field (see below) is set to true, the data from these fields +should override the fields of the same name without the `fallback` prefix. + +`useFallback` → A boolean that allows choosing between the regular `shell` and +`homeDirectory` fields or the fallback fields of the same name (see above). If +`true` the fallback fields should be used in place of the regular fields, if +`false` or unset the regular fields should be used. This mechanism is used for +enable subsystems such as SSH to allow logins into user accounts, whose homed +directories need further unlocking (because the SSH native authentication +cannot release a suitabable disk encryption key), which the fallback shell +provides. + ## Fields in the `signature` section As mentioned, the `signature` section of the user record may contain one or |