Archmox Documentation

docs.archmox.acreetionos.org

Documentation Hub

Welcome to the Archmox documentation hub. Here you'll find porting guides, API references, architecture docs, and manuals for all Archmox components.

Documentation is being actively developed as the port progresses. Check the GitHub repositories for the latest updates.

📖 Porting Guide

How to build and package Archmox components from source. Covers PKGBUILDs, Perl module paths, systemd services, and archiso integration.

⚙ PVE Architecture

Architecture overview of the PVE stack: cluster communication, storage backend abstraction, and VM lifecycle management.

📦 PBS Internals

Content-addressable storage design, chunking strategy, data deduplication, and the pxar archive format.

✉ PMG Configuration

Setting up SMTP proxies, SpamAssassin rules, ClamAV integration, and quarantine management.

🚀 API Reference

REST API documentation for all Archmox components — PVE, PBS, and PMG endpoints.

🔩 Building from Source

How to build Archmox packages from source using PKGBUILDs and the Arch Linux build system.

← Back to Archmox