manpages

user.cfg(5)

USER.CFG(5) Proxmox Backup USER.CFG(5)

NAME

user.cfg - User Configuration

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.
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.
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.

COPYRIGHT AND DISCLAIMER

Copyright (C) 2019-2023, Proxmox Server Solutions GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/

AUTHOR

Proxmox Support Team

COPYRIGHT

2019-2025, Proxmox Server Solutions GmbH

Wednesday, 24 December 2025 <devbuild>