user.cfg

Description

The file /etc/proxmox-backup/user.cfg is a configuration file for Proxmox Backup Server. It contains the user configuration.

File Format

This file contains the list of API users and API tokens.

Each user configuration section starts with the header user: <name>, followed by the user configuration options.

API token configuration starts with the header token: <userid!token_name>, followed by the token configuration. The data used to authenticate tokens is stored in a separate file (token.shadow).

user: root@pam
      comment Superuser
      email test@example.local
      ...

token: root@pam!token1
      comment API test token
      enable true
      expire 0

user: ...

You can use the proxmox-backup-manager user command to manipulate this file.

Options

Section type 'token': ApiToken properties.

Optional properties:

comment<string>

Comment (single line).

enable<boolean>   (default=true)

Enable the account (default). You can set this to '0' to disable the account.

expire<integer> (0 - N)   (default=0)

Account expiration date (seconds since epoch). '0' means no expiration date.

Section type 'user': User properties.

Optional properties:

comment<string>

Comment (single line).

email<string>

E-Mail Address.

enable<boolean>   (default=true)

Enable the account (default). You can set this to '0' to disable the account.

expire<integer> (0 - N)   (default=0)

Account expiration date (seconds since epoch). '0' means no expiration date.

firstname<string>

First name.

lastname<string>

Last name.