# proxmox-offline-mirror.cfg

## Description

The file `/etc/proxmox-offline-mirror.cfg` is a configuration file for Proxmox Offline Mirror. It contains definitions for mirrors, media and subscription keys.

Note that you can use the `--config <file>` switch on most commands or the `PROXMOX_OFFLINE_MIRROR_CONFIG` environment variable to override the default config location.

## Options

Section type '`medium`': Configuration entry for an external medium.

Required properties:

`mirrors``<string>`

  List of [MirrorConfig] IDs which should be synced to medium. Can be specified more than once.

`mountpoint``<string>`

  Mountpoint where medium is available on mirroring system.

`sync``<boolean>`

  Whether to write new files using FSYNC.

`verify``<boolean>`

  Whether to verify existing files or assume they are valid (IO-intensive).

Section type '`mirror`': Configuration entry for a mirrored repository.

Required properties:

`architectures``<string>`

  List of architectures that should be mirrored. Can be specified more than once.

`base-dir``<string>`

  Path to directory containg mirrored repository pool. Can be shared by multiple mirrors.

`key-path``<string>`

  Path to public key file for verifying repository integrity.

`repository``<string>`

  Single repository definition in sources.list format.

`sync``<boolean>`

  Whether to write new files using FSYNC.

`verify``<boolean>`

  Whether to verify existing files or assume they are valid (IO-intensive).

Optional properties:

`ignore-errors``<boolean> (default=false)`

  Whether to downgrade download errors to warnings

`use-subscription` `pve|pbs|pmg|pom`

  Product type

`weak-crypto``[[allow-sha1=<1|0>] [,min-dsa-key-size=<integer>] [,min-rsa-key-size=<integer>]]`

  Whether to allow using weak cryptography algorithms or parameters, deviating from the default policy. `allow-sha1` = `<boolean> (default=false)`

  > Whether to allow SHA-1 based signatures

  `min-dsa-key-size` = `<integer>`

    Whether to lower the key size cutoff for DSA-based signatures

  `min-rsa-key-size` = `<integer>`

    Whether to lower the key size cutoff for RSA-based signatures

`skip-packages``<string>`

  Packages which should be skipped, supports globbing Can be specified more than once.

`skip-sections``<string>`

  Sections which should be skipped Can be specified more than once.

Section type '`subscription`': Subscription key used for accessing enterprise repositories and for offline subscription activation/renewal.

Required properties:

`server-id``<string>`

  Server ID.

Optional properties:

`description``<string>`

  Description, e.g. which system this key is deployed on

`info``<string>`

  base64 encoded subscription info - update with 'refresh' command.

## Copyright and Disclaimer

Copyright (C) 2022 - 2024, 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/