Tools & Add-ons
Tools and add-ons
Scripts that work on an existing host or container instead of creating a new one.
Container and VM scripts create a new guest. The scripts in this section do something else: they maintain the host, change guests that already exist, or add software to a running container. They live in the tools/ folder of the ProxmoxVE repository.
| Section | What is in it | Where the scripts run |
|---|---|---|
| Proxmox VE host tools | 35 scripts from tools/pve/: updates for all containers, post-install routines, upgrades, storage and backup helpers, hardware passthrough, cleanup. | Proxmox VE host shell, with a few exceptions named on the pages (Backup Server, Mail Gateway, Datacenter Manager, two that run inside a container). |
| LXC add-ons | Optional software from tools/addon/ for an existing container. | See each add-on's page. |
| Copy data between containers | 9 scripts from tools/copy-data/ that copy the data directory of Home Assistant, Plex, Zigbee2MQTT or Z-Wave JS UI from one container to another. | Proxmox VE host shell. |
Before you run a tool
- Run tools as root and in a real terminal. Most of them ask their questions in dialogs.
- Read the tool's page first. Each one lists the prompts, the files, package sources, cron jobs and services the script changes, and how to undo it where that is possible.
- Tools act on things you already rely on. Several change APT sources, delete data or stop guests. Take a backup when a page says there is no undo.
- A tool written for Proxmox VE is not an Incus tool. Host tools for Incus are in the Incus repository.