OS Manuals

/usr/local/bin/backup-utility

Toolbox for GitLab CE FIPS 19.0

From gitlab-toolbox-ce-fips-19.0 19.0.8-r2 (enterprise-packages), captured 2026-11-08 by running backup-utility --help (exit 0). permalink

   Usage: backup-utility [--restore|--cleanup] [-f URL] [-t TIMESTAMP] [--skip COMPONENT] [--backend BACKEND] [--s3config CONFIG]

   Options:
     -h, --help                             Show this help message and exit.
     --restore [-t TIMESTAMP | -f URL]      When specified, utility restores from an existing backup specified
                                            as url or timestamp in object storage.
     -f URL                                 http(s):/ftp:/file:/// URL with backup location. Use with --restore.
     -t TIMESTAMP                           Timestamp (part before '_gitlab_backup.tar' in archive name),
                                            can be used to specify backup source or target name.
     --rsyncable                            Pass the '--rsyncable' parameter to gzip for artifact compression.
     --skip COMPONENT                       When specified, utility will skip the backup or restore of COMPONENT.
                                            May be defined multiple times. Valid values for COMPONENT are
                                            db, repositories, and any of the object storages (e.g. 'lfs').
     --backend BACKEND                      Object storage backend to use for backups and data.
                                            Can be either 's3', 'gcs', or 'azure'.
     --backend-backup BACKEND               Object storage backend to use for backups.
                                            Can be either 's3', 'gcs', or 'azure'.
                                            If not set, it will fallback to the value of --backend.
     --backend-data BACKEND                 Object storage backend to use for data.
                                            Can be either 's3', 'gcs', or 'azure'.
                                            If not set, it will fallback to the value of --backend.
     --s3config CONFIG                      S3 backend configuration to use for backups storage.
                                            Special config file for s3cmd (see: https://s3tools.org/usage)
                                            Not required when using the awscli tool.
     --s3tool TOOL                          S3 CLI tool to use for backups and data.
                                            Can be either 's3cmd' or 'awscli'.
     --s3tool-backup TOOL                   S3 CLI tool to use for backups.
                                            Can be either 's3cmd' or 'awscli'.
                                            If not set, it will fallback to the value of --s3tool.
     --s3tool-data TOOL                     S3 CLI tool to use for data.
                                            Can be either 's3cmd' or 'awscli'.
                                            If not set, it will fallback to the value of --s3tool.
     --storage-class CLASSNAME              Pass this storage class to the gcs, s3cmd, aws, or azcopy cli for more
                                            cost-efficient storage of backups.
     --maximum-backups N                    Only keep the most recent N number of backups, deleting others after success.
                                            Requires s3config or AWS credentials to be able to list and delete objects.
     --cleanup                              Run the backup cleanup without creating a new backup. Can be used with the
                                            'maximum-backups' option to clean old remote backups.
     --aws-kms-key-id                       Add KMS key id when S3 bucket is encrypted with a customer key.
     --aws-s3-endpoint-url                  Specify an AWS S3 endpoint URL.
     --aws-region                           Add AWS region (required for AWS STS regionalized endpoint).
     --azure-config-file                    Path of the config file to configure Azure Block Storage access.
     --repositories-server-side             When Gitaly is configured properly, utility will cause Gitaly to backup
                                            repositories directly to object storage.
     --skip-restore-prompt                  Skip prompts during restore process
     --skip-cleanup                         Skip cleanup after backup process
Options (22)
OptionDescriptionSource
-h, --helpShow this help message and exit.help
--restore, -f -tWhen specified, utility restores from an existing backup specified as url or timestamp in object storage.help
-t TIMESTAMPTimestamp (part before '_gitlab_backup.tar' in archive name), can be used to specify backup source or target name.help
--rsyncablePass the '--rsyncable' parameter to gzip for artifact compression.help
--skip COMPONENTWhen specified, utility will skip the backup or restore of COMPONENT.help
--backend BACKENDObject storage backend to use for backups and data.help
--backend-backup BACKENDObject storage backend to use for backups.help
--backend-data BACKENDObject storage backend to use for data.help
--s3config CONFIGS3 backend configuration to use for backups storage.help
--s3tool TOOLS3 CLI tool to use for backups and data.help
--s3tool-backup TOOLS3 CLI tool to use for backups.help
--s3tool-data TOOLS3 CLI tool to use for data.help
--storage-class CLASSNAMEPass this storage class to the gcs, s3cmd, aws, or azcopy cli for more cost-efficient storage of backups.help
--maximum-backups NOnly keep the most recent N number of backups, deleting others after success.help
--cleanupRun the backup cleanup without creating a new backup.help
--aws-kms-key-idAdd KMS key id when S3 bucket is encrypted with a customer key.help
--aws-s3-endpoint-urlSpecify an AWS S3 endpoint URL.help
--aws-regionAdd AWS region (required for AWS STS regionalized endpoint).help
--azure-config-filePath of the config file to configure Azure Block Storage access.help
--repositories-server-sideWhen Gitaly is configured properly, utility will cause Gitaly to backup repositories directly to object storage.help
--skip-restore-promptSkip prompts during restore processhelp
--skip-cleanupSkip cleanup after backup processhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.