Vault resource¶
The vault resource is used to configure how the vault items are handled. The resource is automatically generated by the SFTPPlus process.
This page focuses on the vault resource configuration options. There is a separate page for the vault items configuration. Refer to the dedicated Vault administration page to find out more on how vault items are used inside SFTPPlus and how to integrate with external key management systems.
Below are the available configuration options for the vault resource.
name¶
- Default value:
''
- Optional:
No
- From version:
5.20.0
- Values:
Any text.
- Description:
Human-readable short string used to identify the vault resource.
description¶
- Default value:
''
- Optional:
Yes
- From version:
5.20.0
- Values:
Any character string.
- Description:
Human-readable text with notes about the vault resource.
external_vault_file¶
- Default value:
empty
- Optional:
Yes
- From version:
5.20.0
- Values:
Path on the local filesystem.
- Description:
The path to a file from where to load additional vault items.
This is designed to be used with container or Kubernetes secrets and is expected to be a read-only file.