# Welcome to the Proxmox Offline Mirror documentation!

Copyright (C) 2022 - 2024, Proxmox Server Solutions GmbH
Version 0.6.8 -- Tuesday, 16 September 2025

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

A PDF version of the documentation is also available here

Table of Contents

- Introduction
  - What is Proxmox Offline Mirror?
  - Terminology
  - Technical Overview
  - Getting Help
    - Enterprise Support
    - Community Support Forum
    - Mailing Lists
    - Bug Tracker
  - License
- Installation
  - System Requirements
  - Installation via APT
    - Debian Package Repositories
    - SecureApt
    - Set up the Repository on non Proxmox based systems
- Offline Subscription Keys
  - Minimum Versions for Offline Activation
  - Setup Offline Mirror Key
  - Gather Server IDs
  - Register & Refresh Keys
  - Deploy Keys
- Offline Repository Mirrors
  - Setting Up a Mirror
  - Syncing a Mirror
  - Reducing Mirror Scope
  - Space Management
  - Environment Variables
- Offline Media
  - Setting Up a Medium
  - Syncing a Medium
  - Using a Medium
    - Example: Local Mount Point
    - Example: Local HTTP Server
  - Activating an Subscription Key

Appendix

- Command Syntax
  - `proxmox-offline-mirror`
  - `proxmox-offline-mirror-helper`
- Configuration Files
  - `proxmox-offline-mirror.cfg`
- GNU Free Documentation License