PanOS Docs

PanOS Documentation Hub

Comprehensive technical documentation for building, integrating, and extending PanOS in real-world environments

PanOS Documentation Hub

PanOS is a minimal Linux platform with a first-class JavaScript runtime, designed for fast boot, reproducible builds, and predictable integration in constrained environments.

This documentation set is intentionally large and technical. It includes:

  • Build internals and boot flow
  • Runtime architecture and process model
  • Integration patterns for backend, frontend, edge, CI/CD, and embedded deployments
  • System design playbooks and reference implementations
  • Troubleshooting, optimization, and advanced customization

Fast Start

./0-install-deps.sh
./1-build.sh
./2-run.sh

If this is your first time, read in this order:

  1. Getting Started
  2. Prerequisites
  3. Installation
  4. Building
  5. Running

Tracks

Complete Documentation Map

AreaDocumentAudienceEst. Time
Setup01-getting-started.mdxNew users8 min
Setup02-prerequisites.mdxNew users10 min
Setup03-installation.mdxNew users12 min
Core04-building.mdxBuilders20 min
Core05-running.mdxOperators15 min
Core06-architecture.mdxAdvanced25 min
Dev07-nodejs-integration.mdxJS developers20 min
Ops08-troubleshooting.mdxAll20 min
Delivery09-creating-iso.mdxPlatform engineers18 min
Advanced10-advanced.mdxPower users30 min
Integration11-library-integration-contexts.mdxSystem integrators28 min
Integration12-multi-context-recipes.mdxApplication teams32 min
Design13-system-design-playbook.mdxArchitects30 min
Reference14-reference-implementations.mdxEngineers35 min
Docs15-fumadocs-authoring-guide.mdxMaintainers18 min

Integration Principles

When integrating PanOS as a runtime layer in larger systems, follow these principles:

  1. Define boundaries first: host responsibilities vs guest responsibilities.
  2. Treat boot as a contract: deterministic startup, stable device mappings, explicit kernel params.
  3. Make runtime state observable: expose health, logs, and version metadata.
  4. Design for failure domains: isolate build, boot, application, and transport failures.
  5. Prefer reproducible pipelines: pin kernel, BusyBox, Node.js, and package versions.

What Changed in This Documentation Generation

  • Migrated docs rendering to Fumadocs + MDX for richer structure and maintainability.
  • Added advanced integration context guides and design examples.
  • Preserved the full technical corpus while expanding implementation-oriented recipes.
  • Standardized English writing style for global contributors.

Go to 11-library-integration-contexts.mdx if your main objective is integrating PanOS into real systems.

On this page