docs: Add documentation about offline repor mirror and proxmox-offline-mirror support

* Offline mirror support (air-gapped envs)
        * Add new full Debian repository

Fixes: #385
This commit is contained in:
gyptazy
2025-12-06 12:26:15 +01:00
parent 55c885194e
commit d4560c3af4
2 changed files with 24 additions and 0 deletions

View File

@@ -120,6 +120,8 @@ systemctl start proxlb
Afterwards, ProxLB is running in the background and balances your cluster by your defined balancing method (default: memory). Afterwards, ProxLB is running in the background and balances your cluster by your defined balancing method (default: memory).
**Note**: If you want to use ProxLB with the proxmox-offline-mirror or any other APT mirror tool that does not support the flat repository architecture, please see the [docs](https://github.com/gyptazy/ProxLB/blob/main/docs/02_installation.md#Repo-Mirror-and-Proxmox-Offline-Mirror-Support) how you can add this by using ProxLB's fully repo.
#### Details #### Details
ProxLB provides two different repositories: ProxLB provides two different repositories:
* https://repo.gyptazy.com/stable (only stable release) * https://repo.gyptazy.com/stable (only stable release)

View File

@@ -6,6 +6,7 @@
- [Quick-Start](#quick-start) - [Quick-Start](#quick-start)
- [Details](#details) - [Details](#details)
- [Debian Packages (.deb files)](#debian-packages-deb-files) - [Debian Packages (.deb files)](#debian-packages-deb-files)
- [Repo Mirror and Proxmox Offline Mirror Support](#repo-mirror-and-proxmox-offline-mirror-support)
- [RedHat Package](#redhat-package) - [RedHat Package](#redhat-package)
- [Container Images / Docker](#container-images--docker) - [Container Images / Docker](#container-images--docker)
- [Overview of Images](#overview-of-images) - [Overview of Images](#overview-of-images)
@@ -83,6 +84,27 @@ vi /etc/proxlb/proxlb.yaml
systemctl start proxlb systemctl start proxlb
``` ```
#### Repo Mirror and Proxmox Offline Mirror Support
ProxLB uses the supported flat mirror style for the Debian repository. Unfortunately, not all offline-mirror applications support it. One of the known ones is the official *proxmox-offline-mirror* which is unable to handle flat repositories (see also: [#385](https://github.com/gyptazy/ProxLB/issues/385)).
Therefore, we currently operate and support both ways to avoid everyone force switching to the new repository. As a result, you can simply use this repository:
```
deb https://repo.gyptazy.com/proxlb stable main
```
**Example Config for proxmox-offline-mirror:**
An example config for the proxmox-offline-mirror would look like:
```
mirror: proxlb
architectures amd64
base-dir /var/lib/proxmox-offline-mirror/mirrors/
key-path /etc/apt/trusted.gpg.d/proxlb.asc
repository deb https://repo.gyptazy.com/proxlb stable main
sync true
verify true
```
### RedHat Package ### RedHat Package
There's currently no official support for RedHat based systems. However, there's a dummy .rpm package for such systems in the pipeline which can be found here: There's currently no official support for RedHat based systems. However, there's a dummy .rpm package for such systems in the pipeline which can be found here:
* https://github.com/gyptazy/ProxLB/actions/workflows/20-pipeline-build-rpm-package.yml * https://github.com/gyptazy/ProxLB/actions/workflows/20-pipeline-build-rpm-package.yml