Mirrors/ProxMenux
1
0
Fork 0
mirror of https://github.com/MacRimi/ProxMenux.git synced 2026-06-14 12:27:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

complete i18n migration to /[locale]/ with EN+ES content

Browse Source 
Full rewrite of the docs site under app/[locale]/ with next-intl
in localePrefix:"always" mode. Every page now exists at both
/en/<path> and /es/<path>; the root / shows a meta-refresh + JS
redirect to /<defaultLocale>/ so GitHub Pages serves something
on the apex URL.

Highlights:
- 107 doc pages migrated to file-per-page JSON namespaces under
  messages/en/ and messages/es/. Spanish content is fully
  translated (no copy-of-English placeholders).
- New documentation for the Active Suppressions section in the
  Settings tab and the per-event Dismiss dropdown in the Health
  Monitor modal.
- New screenshots: dismiss-duration-dropdown.png and an updated
  health-suppression-settings.png.
- Pagefind integrated for client-side search; index is built on
  every CI deploy (not committed).
- RSS feeds: per-locale at /<locale>/rss.xml plus root /rss.xml
  for backward compat.
- Removed the dead app/[locale]/guides/[slug]/ route — every
  guide now has its own static page and no markdown source
  remains.
- Fixed orphan link /guides/nvidia -> /guides/nvidia-manual in
  docs/hardware/nvidia-host.
- Removed obsolete components (footer2, calendar, drawer).

Verified locally with `npm ci && npm run build`: 2804 files in
out/, 231 pages indexed by pagefind, root redirect intact, both
locale roots and the new Active Suppressions docs render OK.
This commit is contained in:
MacRimi
2026-05-31 12:41:10 +02:00
parent 875910b4d7
commit 5ca3463bf6
649 changed files with 83958 additions and 11096 deletions
Download Patch File Download Diff File Expand all files Collapse all files

235
web/messages/en/docs/help-info/backup-commands.json Normal file
View File

@@ -0,0 +1,235 @@
{
"meta": {
"title": "Proxmox Backup Commands — vzdump, qmrestore, pct restore | ProxMenux",
"description": "Reference of Proxmox VE backup and restore commands: vzdump for VMs and LXC containers, qmrestore for VMs, pct restore for containers, scheduled backups in /etc/pve/jobs.cfg, hook scripts and exclude paths.",
"ogTitle": "Proxmox Backup Commands — vzdump, qmrestore, pct restore",
"ogDescription": "Reference of vzdump, qmrestore and pct restore commands for backing up and restoring Proxmox VMs and LXC containers.",
"twitterTitle": "Proxmox Backup Commands | ProxMenux",
"twitterDescription": "vzdump, qmrestore and pct restore commands for backing up and restoring Proxmox VMs and containers."
},
"header": {
"title": "Backup and Restore",
"description": "Curated reference of vzdump, qmrestore and pct restore commands for Proxmox backup workflows. Includes scheduling, advanced options like hook scripts / exclude paths / I/O priority, and backup file management.",
"section": "Help and Info"
},
"intro": {
"title": "Three backup modes",
"body": "<strong>snapshot</strong> uses a live snapshot — guest stays running, briefly pauses I/O. <strong>suspend</strong> freezes the VM during backup (safer than snapshot for non-snapshot-aware FS). <strong>stop</strong> shuts down the VM, backs up cold, restarts. Pick by guest tolerance and storage capability."
},
"commandGroups": [
{
"title": "VM Backup",
"commands": [
{
"command": "vzdump <vmid>",
"description": "Create a backup of a specific VM/CT"
},
{
"command": "vzdump <vmid> --storage <storage>",
"description": "Backup VM to specific storage"
},
{
"command": "vzdump <vmid> --mode snapshot",
"description": "Create snapshot backup (for VMs)"
},
{
"command": "vzdump <vmid> --mode suspend",
"description": "Suspend VM during backup"
},
{
"command": "vzdump <vmid> --mode stop",
"description": "Stop VM during backup"
},
{
"command": "vzdump --all",
"description": "Backup all VMs and containers"
},
{
"command": "vzdump --exclude <vmid1>,<vmid2>",
"description": "Backup all except specified VMs"
}
]
},
{
"title": "Backup Options",
"commands": [
{
"command": "vzdump <vmid> --compress zstd",
"description": "Use zstd compression for backup"
},
{
"command": "vzdump <vmid> --pigz <threads>",
"description": "Use pigz with multiple threads"
},
{
"command": "vzdump <vmid> --notes <text>",
"description": "Add notes to backup"
},
{
"command": "vzdump <vmid> --mailto <email>",
"description": "Send notification email"
},
{
"command": "vzdump <vmid> --maxfiles <n>",
"description": "Keep only n backups per VM"
},
{
"command": "vzdump <vmid> --stdexcludes 0",
"description": "Don't exclude temporary files"
},
{
"command": "vzdump <vmid> --quiet 1",
"description": "Suppress output messages"
}
]
},
{
"title": "Restore Backups",
"commands": [
{
"command": "qmrestore <backup-file> <vmid>",
"description": "Restore VM from backup"
},
{
"command": "qmrestore <backup-file> <vmid> --storage <storage>",
"description": "Restore to specific storage"
},
{
"command": "qmrestore <backup-file> <vmid> --unique",
"description": "Create a VM with unique ID"
},
{
"command": "pct restore <vmid> <backup-file>",
"description": "Restore container from backup"
},
{
"command": "pct restore <vmid> <backup-file> --storage <storage>",
"description": "Restore container to specific storage"
},
{
"command": "pct restore <vmid> <backup-file> --rootfs <storage>",
"description": "Restore to specific rootfs"
},
{
"command": "pct restore <vmid> <backup-file> --unprivileged 1",
"description": "Restore as unprivileged CT"
}
]
},
{
"title": "Backup Management",
"commands": [
{
"command": "ls -la /var/lib/vz/dump/",
"description": "List backups in default location"
},
{
"command": "find /var/lib/vz/dump/ -name \"*.vma*\"",
"description": "Find VM backups"
},
{
"command": "find /var/lib/vz/dump/ -name \"*.tar*\"",
"description": "Find container backups"
},
{
"command": "pvesm list <storage>",
"description": "List backups in specific storage"
},
{
"command": "rm /var/lib/vz/dump/<backup-file>",
"description": "Delete a backup file"
},
{
"command": "cat /etc/vzdump.conf",
"description": "Show backup configuration"
}
]
},
{
"title": "Scheduled Backups",
"commands": [
{
"command": "cat /etc/cron.d/vzdump",
"description": "Show backup schedule"
},
{
"command": "nano /etc/vzdump.conf",
"description": "Edit backup configuration"
},
{
"command": "systemctl list-timers",
"description": "List all scheduled tasks"
},
{
"command": "systemctl status cron",
"description": "Check cron service status"
},
{
"command": "grep vzdump /var/log/syslog",
"description": "Check backup logs in syslog"
},
{
"command": "tail -f /var/log/vzdump.log",
"description": "Monitor backup log in real-time"
}
]
},
{
"title": "Advanced Operations",
"commands": [
{
"command": "qmrestore <backup> <vmid> --force",
"description": "Force restore, overwriting existing VM"
},
{
"command": "vzdump <vmid> --dumpdir <directory>",
"description": "Specify custom backup directory"
},
{
"command": "vzdump <vmid> --script <script>",
"description": "Run hook script during backup"
},
{
"command": "vzdump <vmid> --exclude-path <path>",
"description": "Exclude specific paths from backup"
},
{
"command": "vzdump <vmid> --ionice <priority>",
"description": "Set I/O priority for backup process"
},
{
"command": "vzdump <vmid> --lockwait <minutes>",
"description": "Wait for lock"
},
{
"command": "qm importdisk <vmid> <backup> <storage>",
"description": "Import disk from backup"
}
]
}
],
"testRestores": {
"title": "Test your restores",
"bodyRich": "A backup you've never restored isn't a backup. Periodically pick a backup, restore it to a test VMID with <code>qmrestore --unique</code>, boot the resulting VM and confirm the contents are intact. Same idea for containers via <code>pct restore</code>."
},
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/help-info/vm-ct-commands",
"label": "VM and CT Management",
"tail": " — qm and pct lifecycle commands."
},
{
"href": "/docs/help-info/storage-commands",
"label": "Storage and Disks",
"tail": " — pvesm storage management."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}

162
web/messages/en/docs/help-info/gpu-commands.json Normal file
View File

@@ -0,0 +1,162 @@
{
"meta": {
"title": "Proxmox GPU Passthrough Commands — lspci, VFIO, IOMMU, qm set hostpci | ProxMenux",
"description": "Reference for GPU passthrough on Proxmox VE: lspci device identification, VFIO modules, IOMMU groups (intel_iommu / amd_iommu), GRUB and initramfs updates, qm set hostpci0, NVIDIA / AMD / Intel passthrough setup.",
"ogTitle": "Proxmox GPU Passthrough Commands — lspci, VFIO, IOMMU, qm set hostpci",
"ogDescription": "Reference for inspecting and configuring GPU passthrough on Proxmox VE — PCI devices, VFIO modules, IOMMU groups, kernel boot params, qm set hostpci.",
"twitterTitle": "Proxmox GPU Passthrough Commands | ProxMenux",
"twitterDescription": "Inspect PCI devices, configure VFIO and IOMMU, and attach GPUs to VMs on Proxmox VE."
},
"header": {
"title": "GPU Passthrough",
"description": "Reference for inspecting and configuring GPU / TPU passthrough on Proxmox: device identification (lspci), VFIO module setup, IOMMU validation, initramfs / GRUB updates and per-VM passthrough config (qm set hostpci, machine q35, bios ovmf).",
"section": "Help and Info"
},
"intro": {
"title": "IOMMU must be enabled in BIOS / UEFI",
"body": "Before any of these commands matter, IOMMU has to be enabled at the firmware level (look for <em>VT-d</em>, <em>AMD-Vi</em> or <em>IOMMU</em> in BIOS / UEFI). Common GRUB parameters to enable it on the Linux side: <code>intel_iommu=on</code> (Intel) or <code>amd_iommu=on</code> (AMD), often combined with <code>iommu=pt video=efifb:off video=vesa:off</code>."
},
"commandGroups": [
{
"title": "Device Identification",
"commands": [
{
"command": "lspci -nn | grep -i nvidia",
"description": "List NVIDIA PCI devices"
},
{
"command": "lspci -nn | grep -i vga",
"description": "List all VGA compatible devices"
},
{
"command": "lspci -nn | grep -i amd",
"description": "List AMD PCI devices"
},
{
"command": "lspci -nnk | grep -A3 VGA",
"description": "List VGA devices with kernel drivers"
},
{
"command": "lspci -v -s <PCI_ID>",
"description": "Show detailed info for specific PCI device"
}
]
},
{
"title": "VFIO Configuration",
"commands": [
{
"command": "dmesg | grep -i vfio",
"description": "Check VFIO module messages"
},
{
"command": "cat /etc/modprobe.d/vfio.conf",
"description": "Review VFIO passthrough configuration"
},
{
"command": "ls -la /etc/modprobe.d/",
"description": "List all modprobe configuration files"
},
{
"command": "cat /etc/modules",
"description": "Show modules loaded at boot time"
},
{
"command": "lsmod | grep vfio",
"description": "Check if VFIO modules are loaded"
}
]
},
{
"title": "IOMMU Configuration",
"commands": [
{
"command": "cat /etc/default/grub",
"description": "Review GRUB options for IOMMU"
},
{
"command": "update-grub",
"description": "Apply GRUB changes"
},
{
"command": "dmesg | grep -i iommu",
"description": "Check IOMMU messages in kernel log"
},
{
"command": "dmesg | grep -e DMAR -e IOMMU",
"description": "Check DMAR and IOMMU messages"
},
{
"command": "find /sys/kernel/iommu_groups/ -type l | sort -V",
"description": "List IOMMU groups"
}
]
},
{
"title": "System Updates",
"commands": [
{
"command": "update-initramfs -u",
"description": "Apply initramfs changes (VFIO)"
},
{
"command": "update-initramfs -u -k all",
"description": "Update initramfs for all kernels"
},
{
"command": "cat /proc/cmdline",
"description": "Show current kernel boot parameters"
}
]
},
{
"title": "VM Configuration",
"commands": [
{
"command": "qm config <vmid> | grep hostpci",
"description": "Show PCI passthrough config for a VM"
},
{
"command": "qm set <vmid> -hostpci0 <PCI_ID>,pcie=1,x-vga=1",
"description": "Add GPU passthrough to a VM"
},
{
"command": "cat /etc/pve/qemu-server/<vmid>.conf",
"description": "View VM configuration file"
},
{
"command": "qm set <vmid> -machine q35",
"description": "Set VM to use Q35 chipset (recommended for passthrough)"
},
{
"command": "qm set <vmid> -bios ovmf",
"description": "Set VM to use UEFI/OVMF (required for GPU passthrough)"
}
]
}
],
"afterChangesTip": {
"title": "After changing GRUB or modprobe configs",
"bodyRich": "Run <code>update-grub</code> + <code>update-initramfs -u</code>, then reboot. Verify with <code>cat /proc/cmdline</code> (kernel parameters), <code>dmesg | grep -i iommu</code> (IOMMU initialised) and <code>find /sys/kernel/iommu_groups/ -type l | sort -V</code> (groups present)."
},
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/hardware/gpu-vm-passthrough",
"label": "Add GPU to VM (Passthrough)",
"tail": " — interactive ProxMenux flow."
},
{
"href": "/docs/hardware/igpu-acceleration-lxc",
"label": "Add GPU to LXC",
"tail": " — passthrough to a container instead of a VM."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}

87
web/messages/en/docs/help-info/index.json Normal file
View File

@@ -0,0 +1,87 @@
{
"meta": {
"title": "Proxmox Commands Reference — qm, pct, vzdump, zpool, pveversion | ProxMenux",
"description": "Curated reference of essential Proxmox VE and Linux commands organised by topic: system inspection, VM and LXC management (qm / pct), storage and disks, networking, updates, GPU passthrough, ZFS, backup and restore, and day-to-day CLI tools.",
"ogTitle": "Proxmox Commands Reference — qm, pct, vzdump, zpool",
"ogDescription": "Curated reference of the most useful Proxmox VE and Linux commands, grouped by topic — system, VM/CT, storage, network, updates, GPU passthrough, ZFS, backup and CLI tools.",
"twitterTitle": "Proxmox Commands Reference | ProxMenux",
"twitterDescription": "Curated reference of the most useful Proxmox VE and Linux commands, grouped by topic."
},
"header": {
"title": "Help and Info",
"description": "Curated compendium of useful Linux and Proxmox VE commands organised by topic. Nine categories — covers everything from a quick pveversion check to a multi-line zfs send/receive — meant to live alongside the GPU, disk and share sections of ProxMenux as a one-stop reference.",
"section": "Help and Info"
},
"intro": {
"title": "What this is",
"body": "A reference catalog of the commands you actually use on a Proxmox host, grouped by topic. Inside ProxMenux you can pick a number to run a command directly or paste your own at the prompt; on this site each category is a copy-paste table."
},
"opening": {
"heading": "Opening the menu",
"body": "From ProxMenux's main menu, press <kbd>h</kbd>. You will see this:",
"imageAlt": "Help and Info menu with 9 categories of commands"
},
"categories": {
"heading": "The nine categories",
"options": [
{
"icon": "Terminal",
"href": "/docs/help-info/system-commands",
"title": "Useful System Commands",
"description": "pveversion, uptime, free, journalctl, hostnamectl, current-user info, lynis audit, fastfetch."
},
{
"icon": "Cpu",
"href": "/docs/help-info/vm-ct-commands",
"title": "VM and CT Management",
"description": "qm list / config / start / stop / migrate, pct list / config / enter, snapshots, cloning."
},
{
"icon": "HardDrive",
"href": "/docs/help-info/storage-commands",
"title": "Storage and Disks",
"description": "lsblk, blkid, smartctl, mount info, pvesm status, LVM commands."
},
{
"icon": "Network",
"href": "/docs/help-info/network-commands",
"title": "Network Commands",
"description": "ip / ss / nmcli, bridge inspection, ping / traceroute, DNS lookups, fail2ban-client."
},
{
"icon": "Package",
"href": "/docs/help-info/update-commands",
"title": "Updates and Packages",
"description": "apt update / dist-upgrade, apt-cache policy, dpkg queries, repo file checks."
},
{
"icon": "Cpu",
"href": "/docs/help-info/gpu-commands",
"title": "GPU Passthrough",
"description": "lspci / dmesg checks, IOMMU enablement verification, vfio-pci binding, GPU usage from the host."
},
{
"icon": "Database",
"href": "/docs/help-info/zfs-commands",
"title": "ZFS Management",
"description": "zpool / zfs commands for status, datasets, snapshots, send/receive, ARC tuning, trimming."
},
{
"icon": "Archive",
"href": "/docs/help-info/backup-commands",
"title": "Backup and Restore",
"description": "vzdump, qmrestore / pct restore, Proxmox Backup Server helpers, snapshot operations."
},
{
"icon": "Wrench",
"href": "/docs/help-info/tools-commands",
"title": "System CLI Tools",
"description": "tmux, screen, htop / btop, ncdu, jq, dig, lsof, watch — daily-driver admin tools."
}
]
},
"tip": {
"title": "Searchable from the global search",
"body": "Every command in these pages is indexed by the documentation search. If you remember a flag or fragment but not which page it's on, hit the search bar at the top — you'll land directly on the right entry."
}
}

174
web/messages/en/docs/help-info/network-commands.json Normal file
View File

@@ -0,0 +1,174 @@
{
"meta": {
"title": "Proxmox Network Commands — ip, ping, ss, pve-firewall, iptables | ProxMenux",
"description": "Reference of Proxmox VE host networking commands: ip / ip link / ip addr, ping, traceroute, mtr, ss, ethtool, dig, nslookup, plus pve-firewall, iptables and nftables for filtering. Bridge, bond and VLAN inspection.",
"ogTitle": "Proxmox Network Commands — ip, ping, ss, pve-firewall, iptables",
"ogDescription": "Reference of network commands for Proxmox VE — interface inspection, connectivity tests, monitoring, firewall (pve-firewall, iptables, nftables) and DNS lookups.",
"twitterTitle": "Proxmox Network Commands | ProxMenux",
"twitterDescription": "Network inspection, testing, configuration and firewall commands for Proxmox VE."
},
"header": {
"title": "Network Commands",
"description": "Curated reference for Proxmox host networking: interface info, connectivity tests, configuration, traffic monitoring and firewall management. Combines ip / ss / nmcli / ethtool / tcpdump / pve-firewall.",
"section": "Help and Info"
},
"intro": {
"title": "Quick interface inventory",
"body": "<code>ip a</code> shows every interface with its IPs and MAC. <code>ip r</code> shows the routing table. Together they answer most \"is this interface configured correctly?\" questions in seconds."
},
"commandGroups": [
{
"title": "Network Information",
"commands": [
{
"command": "ip a",
"description": "Show network interfaces and IPs"
},
{
"command": "ip r",
"description": "Show routing table"
},
{
"command": "ip -s link",
"description": "Show traffic statistics per interface"
},
{
"command": "brctl show",
"description": "Show configured network bridges"
},
{
"command": "cat /etc/network/interfaces",
"description": "Show raw network configuration"
}
]
},
{
"title": "Network Testing",
"commands": [
{
"command": "ping <host>",
"description": "Check connectivity with another host"
},
{
"command": "traceroute <host>",
"description": "Trace route to a host"
},
{
"command": "mtr <host>",
"description": "Combine ping and traceroute in real-time"
},
{
"command": "dig <domain>",
"description": "DNS lookup for a domain"
},
{
"command": "nslookup <domain>",
"description": "Alternative DNS lookup"
}
]
},
{
"title": "Network Configuration",
"commands": [
{
"command": "ifreload -a",
"description": "Reload network configuration (ifupdown2)"
},
{
"command": "ethtool <iface>",
"description": "Show Ethernet device info"
},
{
"command": "resolvectl status",
"description": "Show DNS resolution status"
},
{
"command": "nmcli device show",
"description": "Show network device details (if NetworkManager is used)"
},
{
"command": "ip link set <iface> up",
"description": "Bring network interface up"
},
{
"command": "ip link set <iface> down",
"description": "Bring network interface down"
}
]
},
{
"title": "Network Monitoring",
"commands": [
{
"command": "ss -tuln",
"description": "Show listening ports (TCP/UDP)"
},
{
"command": "netstat -tuln",
"description": "Alternative to show listening ports"
},
{
"command": "lsof -i",
"description": "List open network files and connections"
},
{
"command": "tcpdump -i <iface>",
"description": "Capture packets on interface"
},
{
"command": "iftop -i <iface>",
"description": "Monitor bandwidth usage on interface"
}
]
},
{
"title": "Firewall Management",
"commands": [
{
"command": "iptables -L -n -v",
"description": "Show active firewall rules (iptables)"
},
{
"command": "nft list ruleset",
"description": "Show nftables rules"
},
{
"command": "pve-firewall status",
"description": "Check Proxmox firewall status"
},
{
"command": "pve-firewall compile",
"description": "Compile firewall rules for all nodes"
},
{
"command": "pve-firewall reload",
"description": "Reload Proxmox firewall rules"
}
]
}
],
"iptablesTip": {
"title": "iptables vs nftables",
"bodyRich": "Modern Debian / Proxmox uses <strong>nftables</strong> as the underlying firewall engine. The classic <code>iptables -L -n -v</code> command still works as a translation layer, but the source of truth is <code>nft list ruleset</code>. <code>pve-firewall</code> commands are Proxmox's wrapper that emits nftables rules from the cluster firewall config."
},
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/network",
"label": "Network Management",
"tail": " — ProxMenux interactive network tools (bridge analysis, persistent names, monitoring)."
},
{
"href": "/docs/help-info/tools-commands",
"label": "System CLI Tools",
"tail": " — more network monitoring tools."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}

232
web/messages/en/docs/help-info/storage-commands.json Normal file
View File

@@ -0,0 +1,232 @@
{
"meta": {
"title": "Proxmox Storage and Disk Commands — lsblk, LVM, pvesm, qm importdisk | ProxMenux",
"description": "Reference of storage and disk commands on Proxmox VE: lsblk, blkid, parted, lvdisplay, vgdisplay, pvs, mount, df, du, ncdu, pvesm status, qm importdisk and qemu-img convert for VM disk operations.",
"ogTitle": "Proxmox Storage and Disk Commands — lsblk, LVM, pvesm, qm importdisk",
"ogDescription": "Reference of storage and disk commands on Proxmox VE — disk inspection, LVM, mounts, Proxmox storage management, VM disk import and image conversion.",
"twitterTitle": "Proxmox Storage Commands | ProxMenux",
"twitterDescription": "Disk inspection, mount info, LVM management, Proxmox storage and VM disk import / conversion commands."
},
"header": {
"title": "Storage and Disks",
"description": "Curated reference for storage inspection on Proxmox hosts: block devices, partitions, mounts, LVM volumes, Proxmox storage configuration, and a few VM disk operations (importdisk, qemu-img convert).",
"section": "Help and Info"
},
"intro": {
"title": "Quick disk inventory",
"body": "<code>lsblk</code> is the fastest way to see all block devices and their partitions in a tree view. For persistent identifiers (which survive between boots and hardware changes) use <code>ls -lh /dev/disk/by-id/</code>."
},
"commandGroups": [
{
"title": "Disk Information",
"commands": [
{
"command": "lsblk",
"description": "List block devices and partitions"
},
{
"command": "fdisk -l",
"description": "List disks with detailed info"
},
{
"command": "blkid",
"description": "Show UUID and filesystem type of block devices"
},
{
"command": "ls -lh /dev/disk/by-id/",
"description": "List disk persistent identifiers"
},
{
"command": "parted -l",
"description": "Detailed partition layout with GPT info"
}
]
},
{
"title": "Storage Usage",
"commands": [
{
"command": "df -h",
"description": "Show disk usage by mount point"
},
{
"command": "du -sh /path",
"description": "Show size of a directory"
},
{
"command": "mount | grep ^/dev",
"description": "Show mounted storage devices"
},
{
"command": "cat /proc/mounts",
"description": "Show all active mounts from the kernel"
}
]
},
{
"title": "LVM Management",
"commands": [
{
"command": "pvdisplay",
"description": "Display physical volumes (LVM)"
},
{
"command": "vgdisplay",
"description": "Display volume groups (LVM)"
},
{
"command": "lvdisplay",
"description": "Display logical volumes (LVM)"
},
{
"command": "pvs",
"description": "Concise output of physical volumes"
},
{
"command": "vgs",
"description": "Concise output of volume groups"
},
{
"command": "lvs",
"description": "Concise output of logical volumes"
}
]
},
{
"title": "Proxmox Storage",
"commands": [
{
"command": "cat /etc/pve/storage.cfg",
"description": "Show Proxmox storage configuration"
},
{
"command": "pvesm status",
"description": "Show status of all storage pools"
},
{
"command": "pvesm list",
"description": "List all available storage"
},
{
"command": "pvesm list <storage>",
"description": "List content of specific storage"
},
{
"command": "pvesm scan <storage>",
"description": "Scan storage for new content"
}
]
},
{
"title": "Disk Actions",
"commands": [
{
"command": "qm importdisk <vmid> <image_path> <storage>",
"description": "Attach disk image to VM"
},
{
"command": "qm set <vmid> -<bus><index> <disk_path>",
"description": "Assign physical disk to VM (passthrough mode)"
},
{
"command": "qemu-img convert -O <format> <input> <output>",
"description": "Convert disk image format"
}
]
},
{
"title": "SMART Disk Health",
"commands": [
{
"command": "smartctl --scan",
"description": "List SMART-capable devices on the host"
},
{
"command": "smartctl -i /dev/<disk>",
"description": "Basic device info (model, firmware, serial)"
},
{
"command": "smartctl -H /dev/<disk>",
"description": "Quick health check — overall PASSED / FAILED"
},
{
"command": "smartctl -A /dev/<disk>",
"description": "SMART attributes only (raw values, thresholds)"
},
{
"command": "smartctl -a /dev/<disk>",
"description": "Full SMART info — info + attributes + self-test log"
},
{
"command": "smartctl -t short /dev/<disk>",
"description": "Start short self-test (~2 minutes, runs in background)"
},
{
"command": "smartctl -t long /dev/<disk>",
"description": "Start long self-test (hours, runs in background)"
},
{
"command": "smartctl -l selftest /dev/<disk>",
"description": "View self-test log (results of past tests)"
},
{
"command": "smartctl -X /dev/<disk>",
"description": "Abort the running self-test"
}
]
},
{
"title": "NVMe Disk Health",
"commands": [
{
"command": "nvme list",
"description": "List NVMe devices visible to the kernel"
},
{
"command": "nvme smart-log /dev/<nvme>",
"description": "NVMe-specific SMART log (temperature, wear, errors)"
},
{
"command": "nvme id-ctrl /dev/<nvme>",
"description": "Controller info (model, firmware, capabilities)"
},
{
"command": "nvme error-log /dev/<nvme>",
"description": "Recent NVMe error log entries"
}
]
}
],
"lvmTip": {
"title": "LVM short vs long commands",
"bodyRich": "Both forms exist for compatibility. <code>pvs</code> / <code>vgs</code> / <code>lvs</code> give a clean single-line-per-volume table; <code>pvdisplay</code> / <code>vgdisplay</code> / <code>lvdisplay</code> give a verbose multi-line dump per volume. For day-to-day use prefer the short versions."
},
"smartInfo": {
"title": "SMART for spinning disks vs NVMe",
"bodyRich": "<strong>Spinning / SATA / SAS disks</strong> use the <code>smartctl</code> family from <code>smartmontools</code> (installed by default on Proxmox). Pass the device as <code>/dev/sda</code>, <code>/dev/sdb</code>, etc. <strong>NVMe disks</strong> have their own native protocol — <code>smartctl</code> works against them (passes most data through), but the <code>nvme</code> tool from <code>nvme-cli</code> reports more NVMe-specific fields (wear levelling, media errors, namespace info). Install with <code>apt install nvme-cli</code> if not present."
},
"selfTestWarn": {
"title": "Self-tests run in the background",
"bodyRich": "<code>smartctl -t short</code> and <code>-t long</code> return immediately — the disk runs the test on its own. Check progress with <code>smartctl -a /dev/&lt;disk&gt;</code> (look for the \"Self-test routine in progress\" line) or wait for completion and read <code>smartctl -l selftest /dev/&lt;disk&gt;</code>. Short tests take ~2 min; long tests can take hours on large spinners. The disk stays usable during the test, but I/O performance drops."
},
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/help-info/zfs-commands",
"label": "ZFS Management",
"tail": " — zpool / zfs commands for ZFS-backed storage."
},
{
"href": "/docs/disk-manager",
"label": "Disk Manager",
"tail": " — interactive ProxMenux flows for disk passthrough, import, formatting, SMART."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}

158
web/messages/en/docs/help-info/system-commands.json Normal file
View File

@@ -0,0 +1,158 @@
{
"meta": {
"title": "Proxmox VE System Commands — pveversion, uptime, journalctl, systemctl | ProxMenux",
"description": "Reference of essential Proxmox VE and Linux system commands: pveversion, pveperf, uptime, journalctl, systemctl, lscpu, lsblk, df, free, last, who. All read-only and safe to run on any host.",
"ogTitle": "Proxmox VE System Commands — pveversion, uptime, journalctl, systemctl",
"ogDescription": "Reference of essential Proxmox VE and Linux system commands — version, uptime, services, logs, user info, hardware probes. All read-only.",
"twitterTitle": "Proxmox VE System Commands | ProxMenux",
"twitterDescription": "Essential system inspection commands for Proxmox VE — version, status, services, logs, user info."
},
"header": {
"title": "Useful System Commands",
"description": "Read-only commands to look at the Proxmox host: version, kernel, uptime, memory, web UI status, recent log lines, who's logged in, and a couple of audit / summary tools. None of them modifies the system.",
"section": "Help and Info"
},
"intro": {
"title": "What this is",
"body": "The same numbered list ProxMenux shows when you choose <em>Useful System Commands</em>. Use the Copy button to grab any command, or look it up to remember the exact flag."
},
"commandGroups": [
{
"title": "System Information",
"commands": [
{
"command": "pveversion",
"description": "Show Proxmox version"
},
{
"command": "pveversion -v",
"description": "Detailed Proxmox version info"
},
{
"command": "hostnamectl",
"description": "System hostname and kernel info"
},
{
"command": "uname -a",
"description": "Kernel and architecture info"
},
{
"command": "cat /etc/os-release",
"description": "OS release details"
}
]
},
{
"title": "System Status",
"commands": [
{
"command": "uptime",
"description": "System uptime"
},
{
"command": "uptime -p",
"description": "Pretty uptime format"
},
{
"command": "free -h",
"description": "RAM and swap usage"
},
{
"command": "who -b",
"description": "Last system boot time"
},
{
"command": "last -x | grep shutdown",
"description": "Previous shutdowns"
}
]
},
{
"title": "Service Management",
"commands": [
{
"command": "systemctl status pveproxy",
"description": "Check Proxmox Web UI status"
},
{
"command": "systemctl restart pveproxy",
"description": "Restart Web UI proxy"
},
{
"command": "journalctl -xe",
"description": "System errors and logs"
},
{
"command": "dmesg -T | tail -n 50",
"description": "Last 50 kernel log lines"
}
]
},
{
"title": "User Information",
"commands": [
{
"command": "whoami",
"description": "Current user"
},
{
"command": "id",
"description": "Current user UID, GID and groups"
},
{
"command": "who",
"description": "Logged-in users"
},
{
"command": "w",
"description": "User activity and uptime"
},
{
"command": "uptime && w",
"description": "Uptime and who is logged in"
},
{
"command": "cut -d: -f1,3,4 /etc/passwd",
"description": "All users with UID and GID"
},
{
"command": "getent passwd | column -t -s :",
"description": "Readable user table (UID, shell, etc.)"
}
]
},
{
"title": "Auditing & Summary Tools",
"commands": [
{
"command": "lynis audit system",
"description": "Run a full system security audit"
},
{
"command": "fastfetch",
"description": "Display system summary in ASCII format"
}
]
}
],
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/help-info/update-commands",
"label": "Updates and Packages",
"tail": " — apt and pve upgrade commands."
},
{
"href": "/docs/help-info/tools-commands",
"label": "System CLI Tools",
"tail": " — htop, btop, ncdu and friends."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}

276
web/messages/en/docs/help-info/tools-commands.json Normal file
View File

@@ -0,0 +1,276 @@
{
"meta": {
"title": "Linux CLI Tools for Proxmox — htop, iftop, journalctl, rsync, tmux | ProxMenux",
"description": "Day-to-day Linux CLI tools for Proxmox VE administration: monitoring (htop, atop, glances, iotop), network (iftop, nmap, mtr, ss), file & text (find, grep, journalctl), performance (iostat, perf, strace), security (fail2ban, lynis, lsof) and remote admin (ssh, rsync, tmux).",
"ogTitle": "Linux CLI Tools for Proxmox — htop, iftop, journalctl, rsync, tmux",
"ogDescription": "Day-to-day CLI tools for Proxmox VE administration grouped by purpose: monitoring, network, file/text, performance, security and remote admin.",
"twitterTitle": "Linux CLI Tools for Proxmox | ProxMenux",
"twitterDescription": "Daily-driver CLI tools for Proxmox VE administration grouped by purpose."
},
"header": {
"title": "System CLI Tools",
"description": "Daily-driver CLI tools for Proxmox host administration, grouped by purpose: monitoring, network, file & text, performance analysis, security, remote admin and system configuration.",
"section": "Help and Info"
},
"intro": {
"title": "Most are installed by Post-Install",
"body": "If you ran the ProxMenux Post-Install script with the default selections, the majority of these tools are already installed. For anything missing, ProxMenux's <utilsLink>System Utilities Installer</utilsLink> offers them as predefined groups (basic, dev, network, analysis, …)."
},
"commandGroups": [
{
"title": "System Monitoring",
"commands": [
{
"command": "htop",
"description": "Interactive process viewer with CPU/memory usage"
},
{
"command": "top",
"description": "Display Linux processes in real-time"
},
{
"command": "atop",
"description": "Advanced system & process monitor"
},
{
"command": "glances",
"description": "System monitoring tool with web interface"
},
{
"command": "nmon",
"description": "Performance monitoring tool"
},
{
"command": "iotop",
"description": "Monitor disk I/O usage by processes"
},
{
"command": "vmstat 1",
"description": "Report virtual memory statistics every second"
}
]
},
{
"title": "Network Tools",
"commands": [
{
"command": "iftop",
"description": "Display bandwidth usage on an interface"
},
{
"command": "nmap <host>",
"description": "Network exploration and security scanning"
},
{
"command": "tcpdump -i <interface>",
"description": "Dump network traffic"
},
{
"command": "netstat -tuln",
"description": "Display network connections"
},
{
"command": "ss -tuln",
"description": "Another utility to investigate sockets"
},
{
"command": "mtr <host>",
"description": "Network diagnostic tool combining ping and traceroute"
},
{
"command": "iperf3 -s",
"description": "Run iperf server for bandwidth testing"
}
]
},
{
"title": "File and Text Tools",
"commands": [
{
"command": "find / -name <filename>",
"description": "Find files by name"
},
{
"command": "grep -r 'pattern' /path",
"description": "Search for pattern in files"
},
{
"command": "sed -i 's/old/new/g' file",
"description": "Replace text in files"
},
{
"command": "awk '{print $1}' file",
"description": "Text processing tool"
},
{
"command": "tail -f /var/log/syslog",
"description": "Follow log file in real-time"
},
{
"command": "less /var/log/messages",
"description": "View file with pagination"
},
{
"command": "journalctl -f",
"description": "Follow systemd journal logs"
}
]
},
{
"title": "Performance Analysis",
"commands": [
{
"command": "iostat -x 1",
"description": "Report CPU and I/O statistics"
},
{
"command": "mpstat -P ALL 1",
"description": "Report CPU utilization"
},
{
"command": "perf top",
"description": "System profiling tool"
},
{
"command": "strace <command>",
"description": "Trace system calls and signals"
},
{
"command": "lsof",
"description": "List open files"
},
{
"command": "pstree",
"description": "Display process tree"
},
{
"command": "slabtop",
"description": "Display kernel slab cache information"
}
]
},
{
"title": "Security Tools",
"commands": [
{
"command": "fail2ban-client status",
"description": "Show fail2ban status"
},
{
"command": "chage -l <username>",
"description": "Show password expiry information"
},
{
"command": "lastlog",
"description": "Show last login of all users"
},
{
"command": "last",
"description": "Show listing of last logged in users"
},
{
"command": "w",
"description": "Show who is logged on and what they are doing"
},
{
"command": "lynis audit system",
"description": "Security auditing tool"
},
{
"command": "openssl s_client -connect host:port",
"description": "Test SSL/TLS connections"
}
]
},
{
"title": "Remote Administration",
"commands": [
{
"command": "ssh <user>@<host>",
"description": "Secure shell connection"
},
{
"command": "scp <file> <user>@<host>:<path>",
"description": "Secure copy files"
},
{
"command": "rsync -avz <src> <dest>",
"description": "Synchronize files/folders"
},
{
"command": "screen",
"description": "Terminal multiplexer"
},
{
"command": "tmux",
"description": "Terminal multiplexer alternative"
},
{
"command": "ssh-keygen -t rsa -b 4096",
"description": "Generate SSH key pair"
},
{
"command": "ssh-copy-id <user>@<host>",
"description": "Copy SSH key to server"
}
]
},
{
"title": "System Configuration",
"commands": [
{
"command": "systemctl status <service>",
"description": "Check service status"
},
{
"command": "journalctl -u <service>",
"description": "View service logs"
},
{
"command": "timedatectl",
"description": "Control system time and date"
},
{
"command": "hostnamectl",
"description": "Control system hostname"
},
{
"command": "localectl",
"description": "Control system locale and keyboard"
},
{
"command": "update-alternatives --config <name>",
"description": "Configure system alternatives"
},
{
"command": "dpkg-reconfigure <package>",
"description": "Reconfigure an installed package"
}
]
}
],
"tmuxTip": {
"title": "Use tmux / screen for long-running commands",
"bodyRich": "Anything that takes longer than a coffee break — a backup, a long upgrade, a big rsync — should run inside <code>tmux</code> or <code>screen</code>. SSH disconnects don't kill the session, and you can re-attach from anywhere with <code>tmux attach</code>."
},
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/utils/system-utils",
"label": "System Utilities Installer",
"tail": " — install any of these tools that are missing."
},
{
"href": "/docs/help-info/system-commands",
"label": "Useful System Commands",
"tail": " — Proxmox-specific inspection commands."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}

170
web/messages/en/docs/help-info/update-commands.json Normal file
View File

@@ -0,0 +1,170 @@
{
"meta": {
"title": "Proxmox Update and Package Commands — apt, pveupgrade, dpkg | ProxMenux",
"description": "Reference of update and package commands for Proxmox VE: apt update, apt upgrade, apt dist-upgrade, pveupgrade, dpkg -l, package information lookups, repository configuration in /etc/apt/sources.list.d/.",
"ogTitle": "Proxmox Update and Package Commands — apt, pveupgrade, dpkg",
"ogDescription": "apt, pveupgrade and dpkg commands for keeping Proxmox VE up to date — system upgrades, package management, repository configuration.",
"twitterTitle": "Proxmox Update Commands | ProxMenux",
"twitterDescription": "apt and pveupgrade commands for managing updates and packages on Proxmox VE hosts."
},
"header": {
"title": "Updates and Packages",
"description": "Curated reference of apt and Proxmox-specific upgrade commands: system updates, package install / remove / purge, package lookups (apt-cache policy, dpkg -l), and repository configuration inspection.",
"section": "Help and Info"
},
"intro": {
"title": "Always update the index first",
"body": "<code>apt update</code> refreshes the local package index from the configured repositories. Without it, <code>apt install</code> may pull stale versions or fail with \"Unable to locate package\"."
},
"commandGroups": [
{
"title": "System Updates",
"commands": [
{
"command": "apt update && apt upgrade -y",
"description": "Update and upgrade all system packages"
},
{
"command": "apt dist-upgrade -y",
"description": "Full system upgrade, including dependencies"
},
{
"command": "apt update",
"description": "Update package lists only"
},
{
"command": "apt upgrade",
"description": "Upgrade packages only (interactive)"
},
{
"command": "apt full-upgrade",
"description": "Upgrade packages with dependency handling (interactive)"
}
]
},
{
"title": "Proxmox Updates",
"commands": [
{
"command": "pveupdate",
"description": "Update Proxmox package lists"
},
{
"command": "pveupgrade",
"description": "Show available Proxmox upgrades"
},
{
"command": "pve-upgrade",
"description": "Perform Proxmox VE upgrade"
},
{
"command": "pveceph upgrade",
"description": "Upgrade Ceph packages (if Ceph is installed)"
}
]
},
{
"title": "Package Management",
"commands": [
{
"command": "apt autoremove --purge",
"description": "Remove unused packages and their config"
},
{
"command": "apt clean",
"description": "Clear out the local repository of retrieved package files"
},
{
"command": "apt autoclean",
"description": "Clear out only outdated package files"
},
{
"command": "apt install <package>",
"description": "Install a specific package"
},
{
"command": "apt remove <package>",
"description": "Remove a package"
},
{
"command": "apt purge <package>",
"description": "Remove a package and its configuration files"
}
]
},
{
"title": "Package Information",
"commands": [
{
"command": "apt list --installed",
"description": "List all installed packages"
},
{
"command": "apt search <keyword>",
"description": "Search for packages by keyword"
},
{
"command": "apt show <package>",
"description": "Show detailed information about a package"
},
{
"command": "dpkg -l",
"description": "List all installed packages (alternative)"
},
{
"command": "dpkg -l | grep <keyword>",
"description": "Search installed packages by keyword"
},
{
"command": "apt-cache policy <package>",
"description": "Show package versions and priorities"
}
]
},
{
"title": "Repository Management",
"commands": [
{
"command": "cat /etc/apt/sources.list",
"description": "Show main APT repository sources"
},
{
"command": "ls -la /etc/apt/sources.list.d/",
"description": "List additional repository source files"
},
{
"command": "cat /etc/apt/sources.list.d/pve-enterprise.list",
"description": "Show Proxmox Enterprise repo config"
},
{
"command": "apt-key list",
"description": "List repository signing keys"
}
]
}
],
"backupWarn": {
"title": "Take a backup before major upgrades",
"bodyRich": "For point releases (8.4.1 → 8.4.5) the standard <code>apt update &amp;&amp; apt upgrade</code> is safe. For <strong>major version upgrades</strong> (PVE 8 → 9) use the dedicated ProxMenux flow: <upgradeLink>Upgrade PVE 8 to PVE 9</upgradeLink> — it adds pre-flight checks, repository migration and post-upgrade validation."
},
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/utils/system-update",
"label": "Proxmox System Update (interactive)",
"tail": " — wrapper that does all of this with a confirmation dialog and reboot prompt."
},
{
"href": "/docs/utils/upgrade-pve8-pve9",
"label": "Upgrade PVE 8 to PVE 9",
"tail": " — for major-version upgrades."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}

182
web/messages/en/docs/help-info/vm-ct-commands.json Normal file
View File

@@ -0,0 +1,182 @@
{
"meta": {
"title": "Proxmox qm and pct Commands — VM and LXC Container Management | ProxMenux",
"description": "Reference of Proxmox VE qm and pct commands for VMs and LXC containers: list, config, start, stop, shutdown, reboot, destroy, clone, migrate, snapshot, resize, plus pct exec / enter / push / pull for containers.",
"ogTitle": "Proxmox qm and pct Commands — VM and LXC Container Management",
"ogDescription": "Reference of Proxmox VE qm and pct commands — manage virtual machines and LXC containers from the CLI: start, stop, configure, snapshot, migrate, clone, destroy.",
"twitterTitle": "Proxmox qm / pct Commands | ProxMenux",
"twitterDescription": "Curated qm / pct commands for managing virtual machines and LXC containers in Proxmox VE."
},
"header": {
"title": "VM and CT Management",
"description": "Curated reference for the qm (VMs) and pct (LXC containers) commands. Listing, lifecycle (start / stop / shutdown / destroy), config inspection, and container-specific operations like exec, enter, push and pull.",
"section": "Help and Info"
},
"intro": {
"title": "Find a VMID or CTID first",
"body": "Almost every command needs a numeric ID. Use <code>qm list</code> for VMs and <code>pct list</code> for containers. Replace <code>&lt;vmid&gt;</code> / <code>&lt;ctid&gt;</code> in the snippets with the actual ID before running."
},
"commandGroups": [
{
"title": "Listing and Information",
"commands": [
{
"command": "qm list",
"description": "List all virtual machines"
},
{
"command": "pct list",
"description": "List all LXC containers"
},
{
"command": "qm config <vmid>",
"description": "Show VM configuration (parsed by qm)"
},
{
"command": "pct config <ctid>",
"description": "Show container configuration (parsed by pct)"
}
]
},
{
"title": "Configuration Files (raw)",
"commands": [
{
"command": "cat /etc/pve/qemu-server/<vmid>.conf",
"description": "View raw VM configuration file"
},
{
"command": "cat /etc/pve/lxc/<ctid>.conf",
"description": "View raw CT configuration file"
},
{
"command": "nano /etc/pve/qemu-server/<vmid>.conf",
"description": "Edit raw VM configuration file (nano)"
},
{
"command": "nano /etc/pve/lxc/<ctid>.conf",
"description": "Edit raw CT configuration file (nano)"
},
{
"command": "vi /etc/pve/qemu-server/<vmid>.conf",
"description": "Edit raw VM configuration file (vi)"
},
{
"command": "vi /etc/pve/lxc/<ctid>.conf",
"description": "Edit raw CT configuration file (vi)"
}
]
},
{
"title": "VM Management",
"commands": [
{
"command": "qm start <vmid>",
"description": "Start a virtual machine. Use the correct <vmid>"
},
{
"command": "qm stop <vmid>",
"description": "Force stop a virtual machine. Use the correct <vmid>"
},
{
"command": "qm shutdown <vmid>",
"description": "Gracefully shutdown a virtual machine"
},
{
"command": "qm reset <vmid>",
"description": "Reset a virtual machine (hard reboot)"
},
{
"command": "qm suspend <vmid>",
"description": "Suspend a virtual machine"
},
{
"command": "qm resume <vmid>",
"description": "Resume a suspended virtual machine"
},
{
"command": "qm destroy <vmid>",
"description": "Delete a VM (irreversible). Use the correct <vmid>"
}
]
},
{
"title": "Container Management",
"commands": [
{
"command": "pct start <ctid>",
"description": "Start a container. Use the correct <ctid>"
},
{
"command": "pct stop <ctid>",
"description": "Force stop a container. Use the correct <ctid>"
},
{
"command": "pct shutdown <ctid>",
"description": "Gracefully shutdown a container"
},
{
"command": "pct restart <ctid>",
"description": "Restart a container"
},
{
"command": "pct destroy <ctid>",
"description": "Delete a CT (irreversible). Use the correct <ctid>"
}
]
},
{
"title": "Container Operations",
"commands": [
{
"command": "pct exec <ctid> -- getent passwd | column -t -s :",
"description": "Show CT users in table format"
},
{
"command": "pct exec <ctid> -- ps aux --sort=-%mem | head",
"description": "Top memory processes in CT"
},
{
"command": "pct enter <ctid>",
"description": "Enter container shell"
},
{
"command": "pct push <ctid> <source> <dest>",
"description": "Copy file from host to container"
},
{
"command": "pct pull <ctid> <source> <dest>",
"description": "Copy file from container to host"
}
]
}
],
"destroyWarn": {
"title": "Destroy is irreversible",
"bodyRich": "<code>qm destroy</code> and <code>pct destroy</code> delete the VM / CT and all its disks. There is no confirmation prompt by default. Take a backup first if there's any chance you might want the data back — see <backupLink>Backup and Restore</backupLink>."
},
"qmConfigTip": {
"title": "qm config vs editing the .conf file directly",
"bodyRich": "<code>qm config &lt;vmid&gt;</code> and <code>pct config &lt;ctid&gt;</code> read the file through Proxmox's own parser — output is normalised, comments stripped, pending changes shown separately. Editing <code>/etc/pve/qemu-server/&lt;vmid&gt;.conf</code> or <code>/etc/pve/lxc/&lt;ctid&gt;.conf</code> directly bypasses the parser. Useful for fixing a corrupted config or applying a setting <code>qm set</code> won't accept, but stop the guest first to avoid races. The cluster filesystem (<code>pmxcfs</code>) takes care of propagating the change to other nodes."
},
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/help-info/backup-commands",
"label": "Backup and Restore",
"tail": " — vzdump and qmrestore / pct restore."
},
{
"href": "/docs/help-info/storage-commands",
"label": "Storage and Disks",
"tail": " — qm importdisk and disk management."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}

227
web/messages/en/docs/help-info/zfs-commands.json Normal file
View File

@@ -0,0 +1,227 @@
{
"meta": {
"title": "ZFS Commands on Proxmox — zpool, zfs snapshot, send/receive, scrub | ProxMenux",
"description": "Reference of ZFS management commands on Proxmox VE: zpool create / status / history, zfs list / get / set, snapshots, clone, zfs send and receive, scrub, clear, replace, zpool iostat, ARC summary.",
"ogTitle": "ZFS Commands on Proxmox — zpool, zfs snapshot, send/receive, scrub",
"ogDescription": "Reference of zpool and zfs commands on Proxmox VE — pools, datasets, snapshots, replication, maintenance.",
"twitterTitle": "ZFS Commands on Proxmox | ProxMenux",
"twitterDescription": "zpool and zfs commands for Proxmox VE: pools, datasets, snapshots, replication, maintenance."
},
"header": {
"title": "ZFS Management",
"description": "Curated reference for zpool and zfs commands: pool inspection, dataset CRUD, snapshots, clone and send/receive (incremental and recursive), scrub / clear / replace for maintenance, plus I/O statistics and ARC summary.",
"section": "Help and Info"
},
"intro": {
"title": "Two command families",
"body": "<code>zpool *</code> manages the storage pools (physical layer — disks, vdevs, redundancy). <code>zfs *</code> manages the datasets and snapshots that live inside those pools (logical layer — filesystems, volumes, snapshots, properties)."
},
"commandGroups": [
{
"title": "Pool Information",
"commands": [
{
"command": "zpool list",
"description": "List all ZFS pools"
},
{
"command": "zpool status",
"description": "Show detailed pool status and health"
},
{
"command": "zpool status -v",
"description": "Show verbose pool status with errors"
},
{
"command": "zpool history",
"description": "Show command history for all pools"
},
{
"command": "zpool history <pool>",
"description": "Show command history for specific pool"
},
{
"command": "zpool get all <pool>",
"description": "Show all properties of a pool"
}
]
},
{
"title": "Dataset Management",
"commands": [
{
"command": "zfs list",
"description": "List all ZFS datasets"
},
{
"command": "zfs list -r <pool>",
"description": "List all datasets in a pool recursively"
},
{
"command": "zfs create <pool>/<dataset>",
"description": "Create a new dataset"
},
{
"command": "zfs destroy <pool>/<dataset>",
"description": "Destroy a dataset"
},
{
"command": "zfs rename <pool>/<dataset> <pool>/<new-name>",
"description": "Rename a dataset"
},
{
"command": "zfs get all <pool>/<dataset>",
"description": "Show all properties of a dataset"
},
{
"command": "zfs set compression=on <pool>/<dataset>",
"description": "Enable compression on a dataset"
}
]
},
{
"title": "Snapshot Management",
"commands": [
{
"command": "zfs list -t snapshot",
"description": "List all snapshots"
},
{
"command": "zfs list -t snapshot -r <pool>",
"description": "List all snapshots in a pool"
},
{
"command": "zfs snapshot <pool>/<dataset>@<snapshot-name>",
"description": "Create a snapshot"
},
{
"command": "zfs destroy <pool>/<dataset>@<snapshot-name>",
"description": "Delete a snapshot"
},
{
"command": "zfs rollback <pool>/<dataset>@<snapshot-name>",
"description": "Rollback to a snapshot"
},
{
"command": "zfs hold <tag> <pool>/<dataset>@<snapshot-name>",
"description": "Place a hold on a snapshot"
},
{
"command": "zfs release <tag> <pool>/<dataset>@<snapshot-name>",
"description": "Release a hold on a snapshot"
}
]
},
{
"title": "Clone and Send/Receive",
"commands": [
{
"command": "zfs clone <pool>/<dataset>@<snapshot> <pool>/<clone-name>",
"description": "Create a clone from a snapshot"
},
{
"command": "zfs send <pool>/<dataset>@<snapshot> > backup.zfs",
"description": "Send a snapshot to a file"
},
{
"command": "zfs receive <pool>/<dataset> < backup.zfs",
"description": "Receive a snapshot from a file"
},
{
"command": "zfs send -i <pool>/<dataset>@<snap1> <pool>/<dataset>@<snap2> > incr.zfs",
"description": "Send incremental snapshot"
},
{
"command": "zfs send -R <pool>/<dataset>@<snapshot> > full-recursive.zfs",
"description": "Send recursive snapshot"
}
]
},
{
"title": "Maintenance and Repair",
"commands": [
{
"command": "zpool scrub <pool>",
"description": "Start a scrub operation on a pool"
},
{
"command": "zpool scrub -s <pool>",
"description": "Stop a running scrub"
},
{
"command": "zpool clear <pool>",
"description": "Clear error counts in a pool"
},
{
"command": "zpool clear <pool> <device>",
"description": "Clear errors on a specific device"
},
{
"command": "zpool replace <pool> <old-device> <new-device>",
"description": "Replace a failed device"
},
{
"command": "zpool offline <pool> <device>",
"description": "Take a device offline"
},
{
"command": "zpool online <pool> <device>",
"description": "Bring a device online"
}
]
},
{
"title": "Performance and Monitoring",
"commands": [
{
"command": "zpool iostat",
"description": "Show I/O statistics for pools"
},
{
"command": "zpool iostat -v",
"description": "Show detailed I/O statistics"
},
{
"command": "zpool iostat 5",
"description": "Show I/O statistics every 5 seconds"
},
{
"command": "arc_summary",
"description": "Show ARC statistics (if installed)"
},
{
"command": "zfs get compressratio <pool>/<dataset>",
"description": "Show compression ratio"
},
{
"command": "zfs get used,available,referenced <pool>/<dataset>",
"description": "Show space usage"
}
]
}
],
"bestPractices": {
"title": "Operational best practices",
"bodyRich": "Run <code>zpool scrub</code> weekly or monthly to detect silent corruption. Keep at least 10-15% of pool space free — ZFS performance degrades sharply over 80% full. Always replace failed devices with <code>zpool replace</code> (in-place) rather than detach + add (which loses redundancy temporarily)."
},
"related": {
"heading": "Related",
"items": [
{
"href": "/docs/help-info/storage-commands",
"label": "Storage and Disks",
"tail": " — generic block-device and LVM commands."
},
{
"href": "/docs/help-info/backup-commands",
"label": "Backup and Restore",
"tail": " — vzdump, qmrestore."
},
{
"href": "/docs/help-info",
"label": "Help and Info overview",
"tail": "."
}
]
}
}