Environment variables

NPBackup envrionment variables usage

NPBackup creates the following environment variables that can be used by pre/post scripts or in additional parameters commands:

• NPBACKUP_BACKEND_BINARY: Path to current backend executable (usually restic)
• NPBACKUP_UPGRADE_STATE: Shows if an inplace upgrade request succeed or failed

NPBackup accepts the following settings as environment variables:

• NPBACKUP_KEY_LOCATION: Alternative AES encryption key file path
• NPBACKUP_KEY_COMMAND: Alternative AES encryption key returned by command
• RESTIC_REPOSITORY: Only used in viewer mode, can be set to autoload a repository
• RESTIC_PASSWORD: Only used in viewer mode, can be set to autoload a repository
• _NPBACKUP_ALLOW_AUTOUPGRADE_DEBUG: Don't actually execute autoupgrade command, just log the command. Also allow non binary distribution inplace upgrades
• NPBACKUP_LOCALE: Change default language, accepts RFC1766 locales. Currently supported are 'fr_FR' and 'en_US'
• GOMAXPROCS: Maximum of cores to use for restic backend, defaults to:
  • (cpu count -1) for any cpu count between 2 and 4
  • (cpu count -2) for any cpu count over 4
• NPBACKUP_MANAGER_PASSWORD: Allows to show sensible data with --show-config when set with the right password

Encrypted environment variables, # NPF-SEC-00013

Please note that encrypted environment variables, RESTIC_REPOSITORY and RESTIC_PASSWORD variables are not accessible by scripts or additional parameters, since they are secure.