Skip to content

Environment Variables & CLI Reference

Supported environment variables, CLI parameters, and configuration priority for PxeLab.

Related: Config File Reference | Deployment


CLI Parameters

pxelab [flags]

Flags:
  --config string       Config file path
  --data-dir string     Data directory (default "~/.pxelab/")
  --log-level string    Log level: debug/info/warn/error (default "info")
  --mode string         Run mode: app/server ("app" auto-opens browser)

Configuration Priority

CLI parameters > Config file > Environment variables > Default values

PrioritySourceDescription
1 (Highest)--config / --data-dir CLI parametersExplicitly specified on command line
2config.yamlConfig file
3Environment variablesSystem environment variables
4 (Lowest)Built-in defaultsHardcoded default values

Common Environment Variables

PxeLab primarily manages settings via config file. These environment variables are available for special scenarios:

Environment VariableDescriptionDefault
PXELAB_DATA_DIRData directory path~/.pxelab/
PXELAB_LOG_LEVELLog levelinfo
PXELAB_LISTEN_ADDRHTTP listen address:8080

Data Directory Structure

~/.pxelab/
├── config.yaml          # Config file
├── pxelab.db            # SQLite database
├── boot/                # Boot files (iPXE, PXELinux, GRUB2 binaries)
│   ├── ipxe.efi
│   ├── undionly.kpxe
│   └── ...
├── netboot/             # Netboot catalog (distro index)
├── os-images/           # OS image storage
├── logs/                # Log files
│   └── pxelab.log
└── volumes/             # NFS mount point data

PxeLab - All-in-one PXE Network Boot Server