mirror of
https://github.com/MacRimi/ProxMenux.git
synced 2026-06-13 20:06:59 +00:00
complete i18n migration to /[locale]/ with EN+ES content
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
175
web/messages/en/docs/create-vm/index.json
Normal file
175
web/messages/en/docs/create-vm/index.json
Normal file
@@ -0,0 +1,175 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Create VMs on Proxmox VE — Synology, Windows, Linux, NAS Wizards | ProxMenux",
|
||||
"description": "Create and configure virtual machines on Proxmox VE with ProxMenux. Dedicated wizards for NAS appliances (Synology DSM, TrueNAS, OpenMediaVault, UnRAID, etc.), Windows, Linux distros, and an external macOS installer. Sensible defaults for VM hardware, storage and networking.",
|
||||
"ogTitle": "Create VMs on Proxmox VE — Synology, Windows, Linux, NAS Wizards",
|
||||
"ogDescription": "ProxMenux wizards for creating Synology DSM, TrueNAS, OMV, UnRAID, Windows and Linux VMs on Proxmox VE.",
|
||||
"ogImageAlt": "ProxMenux Create VM Menu",
|
||||
"twitterTitle": "Create VMs on Proxmox VE | ProxMenux",
|
||||
"twitterDescription": "Wizards for Synology, TrueNAS, OMV, UnRAID, Windows and Linux VMs on Proxmox VE."
|
||||
},
|
||||
"header": {
|
||||
"title": "Create VM",
|
||||
"description": "ProxMenux groups VM creation into an interactive dispatcher. Pick the operating system family and the matching wizard handles ISO selection, CPU, RAM, BIOS, network, storage and — optionally — GPU passthrough.",
|
||||
"section": "Virtual Machines"
|
||||
},
|
||||
"intro": {
|
||||
"title": "What this menu is for",
|
||||
"body": "The Create VM menu is a router, not a single wizard. It asks which operating system family you want to install and loads the appropriate ISO selector and configurator. Default flows use sensible ProxMenux presets; Advanced flows expose every configurable option before the VM is created."
|
||||
},
|
||||
"opening": {
|
||||
"heading": "Opening the menu",
|
||||
"body": "From ProxMenux's main menu, select <strong>Create VM</strong>. You will see this:",
|
||||
"imageAlt": "Create VM dispatcher with 3 ProxMenux options (NAS / Windows / Linux) followed by the Community Scripts section (macOS / Others)"
|
||||
},
|
||||
"families": {
|
||||
"heading": "Three OS families",
|
||||
"intro": "The three ProxMenux entries at the top of the menu share the same underlying engine and post-ISO flow — they just route to different ISO selectors and apply defaults tuned for each family. Pick the one that matches the guest you want to install.",
|
||||
"routes": [
|
||||
{
|
||||
"key": "nas",
|
||||
"title": "System NAS",
|
||||
"icon": "HardDrive",
|
||||
"href": "/docs/create-vm/system-nas",
|
||||
"accent": "border-emerald-300 bg-emerald-50",
|
||||
"iconBg": "bg-emerald-100 text-emerald-700",
|
||||
"description": "Seven NAS operating systems as dedicated VMs. Most use the auto-ISO flow; Synology DSM runs the specialised loader wizard.",
|
||||
"bullets": [
|
||||
"Synology DSM (ARC / RR / TinyCore loaders)",
|
||||
"TrueNAS SCALE and CORE (ZFS)",
|
||||
"OpenMediaVault (Debian-based)",
|
||||
"XigmaNAS (FreeBSD ZFS)",
|
||||
"Rockstor (openSUSE / Btrfs), ZimaOS"
|
||||
]
|
||||
},
|
||||
{
|
||||
"key": "windows",
|
||||
"title": "System Windows",
|
||||
"icon": "MonitorCog",
|
||||
"href": "/docs/create-vm/system-windows",
|
||||
"accent": "border-blue-300 bg-blue-50",
|
||||
"iconBg": "bg-blue-100 text-blue-700",
|
||||
"description": "Windows 10, 11 and Server editions with Windows-friendly defaults (q35 + OVMF + TPM 2.0) and VirtIO drivers pre-mounted.",
|
||||
"bullets": [
|
||||
"UUP Dump for up-to-date ISOs",
|
||||
"Or local ISO from /var/lib/vz/template/iso",
|
||||
"TPM 2.0 added automatically",
|
||||
"VirtIO drivers ISO attached to ide3",
|
||||
"Guest agent channel enabled"
|
||||
]
|
||||
},
|
||||
{
|
||||
"key": "linux",
|
||||
"title": "System Linux",
|
||||
"icon": "Laptop",
|
||||
"href": "/docs/create-vm/system-linux",
|
||||
"accent": "border-amber-300 bg-amber-50",
|
||||
"iconBg": "bg-amber-100 text-amber-700",
|
||||
"description": "Curated catalogue of official Linux ISOs auto-downloaded from upstream, plus a local-ISO picker for anything else.",
|
||||
"bullets": [
|
||||
"Ubuntu (Desktop / Server, 20.04–25.10)",
|
||||
"Debian (Desktop / Netinst, 11–13)",
|
||||
"Fedora, Arch, Rocky, Mint, openSUSE",
|
||||
"Alpine, Kali, Manjaro",
|
||||
"Local ISO path for custom images"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"community": {
|
||||
"title": "Community scripts (not documented here)",
|
||||
"intro": "The two entries below the <em>Community Scripts</em> separator run code that is <strong>not part of ProxMenux</strong>, so they are intentionally left outside this documentation:",
|
||||
"macosRich": "<strong>System macOS</strong> — runs the external <osxLink>OSX-PROXMOX</osxLink> installer. It clones the upstream repository, prepares the host and <strong>reboots automatically when finished</strong>. Refer to the project's own documentation.",
|
||||
"othersRich": "<strong>System Others (Linux-based)</strong> — loads a curated list of community Linux-based installers (home-server OSes, router/firewall appliances, etc.). Each community script is maintained outside ProxMenux."
|
||||
},
|
||||
"afterPick": {
|
||||
"heading": "What happens after you pick an OS",
|
||||
"intro": "Once the ISO is selected, the dispatcher takes the same path regardless of OS family:",
|
||||
"items": [
|
||||
"<strong>Default vs Advanced.</strong> A confirmation dialog lets you accept ProxMenux presets or open the full configurator (CPU model/cores, RAM, BIOS/UEFI, NIC model, machine type).",
|
||||
"<strong>Storage plan.</strong> You combine one or several virtual disks, imported disks and PCI passthrough devices (whole controller / NVMe) in the same VM.",
|
||||
"<strong>Optional GPU passthrough.</strong> If a compatible GPU is detected on the host, ProxMenux offers to launch the GPU assistant after the VM is created — a reboot may be required.",
|
||||
"<strong>VM creation.</strong> The VM is built, tagged, and a styled HTML description is attached to it for quick reference in the Proxmox UI."
|
||||
],
|
||||
"tipTitle": "Prefer Advanced for VMs you intend to keep",
|
||||
"tipBody": "Default presets work well for quick tests. For a VM you intend to keep, the Advanced path lets you pick the right BIOS (SeaBIOS vs OVMF/UEFI), machine type (<code>i440fx</code> vs <code>q35</code>) and disk controller (VirtIO SCSI single vs SATA) up front — these are painful to change later."
|
||||
},
|
||||
"scripts": {
|
||||
"heading": "Scripts involved",
|
||||
"intro": "The dispatcher sources several shared component scripts not documented as individual pages. They are listed here for reference. Each sub-page links to the main script relevant to its flow.",
|
||||
"headerScript": "Script",
|
||||
"headerRole": "Role",
|
||||
"rows": [
|
||||
{
|
||||
"path": "menus/create_vm_menu.sh",
|
||||
"role": "Entry point dispatcher."
|
||||
},
|
||||
{
|
||||
"path": "vm/select_nas_iso.sh",
|
||||
"role": "ISO / appliance selector for NAS systems (Synology, TrueNAS, OMV, Rockstor, ZimaOS)."
|
||||
},
|
||||
{
|
||||
"path": "vm/select_windows_iso.sh",
|
||||
"role": "Windows ISO selector. Delegates to the UUP Dump builder when needed."
|
||||
},
|
||||
{
|
||||
"path": "vm/select_linux_iso.sh",
|
||||
"role": "Linux ISO selector for the Linux flow (mainstream distributions)."
|
||||
},
|
||||
{
|
||||
"path": "vm/synology.sh",
|
||||
"role": "Synology DSM flow: fetches loader and DSM image and prepares the VM profile."
|
||||
},
|
||||
{
|
||||
"path": "vm/zimaos.sh",
|
||||
"role": "ZimaOS flow: downloads the image and wires it into the VM definition."
|
||||
},
|
||||
{
|
||||
"path": "vm/vm_configurator.sh",
|
||||
"role": "Default vs Advanced wizard: CPU model/cores, RAM, BIOS, NIC, machine type."
|
||||
},
|
||||
{
|
||||
"path": "vm/disk_selector.sh",
|
||||
"role": "Storage plan: virtual disk, disk import, or Controller/NVMe passthrough."
|
||||
},
|
||||
{
|
||||
"path": "vm/vm_creator.sh",
|
||||
"role": "Final VM creation: applies the config, attaches storage, writes the HTML description."
|
||||
},
|
||||
{
|
||||
"path": "vm/guest_agent_config.sh",
|
||||
"role": "Optional QEMU guest agent setup hook, used by several flows."
|
||||
}
|
||||
]
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
"items": [
|
||||
{
|
||||
"href": "/docs/disk-manager",
|
||||
"label": "Disk Manager",
|
||||
"tail": " — attach existing physical disks or import disk images into VMs."
|
||||
},
|
||||
{
|
||||
"href": "/docs/utils/UUp-Dump-ISO-Creator",
|
||||
"label": "UUP Dump ISO Creator",
|
||||
"tail": " — generate Windows install ISOs ready to use as boot media."
|
||||
},
|
||||
{
|
||||
"href": "/docs/utils/import-vm",
|
||||
"label": "Import VM from OVA / OVF",
|
||||
"tail": " — bring in pre-built VMs from VMware / VirtualBox / ProxMenux exports."
|
||||
},
|
||||
{
|
||||
"href": "/docs/hardware/gpu-vm-passthrough",
|
||||
"label": "Add GPU to VM (Passthrough)",
|
||||
"tail": " — pass a GPU into a freshly-created VM."
|
||||
},
|
||||
{
|
||||
"href": "/docs/help-info/vm-ct-commands",
|
||||
"label": "VM and CT Management commands",
|
||||
"tail": " — qm reference for the CLI side."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
452
web/messages/en/docs/create-vm/synology.json
Normal file
452
web/messages/en/docs/create-vm/synology.json
Normal file
@@ -0,0 +1,452 @@
|
||||
{
|
||||
"title": "Synology VM Creator Script",
|
||||
"intro": {
|
||||
"heading": "Introduction",
|
||||
"intro": "ProxMenux provides an automated script that creates and configures a virtual machine (VM) to install Synology DSM (DiskStation Manager) on Proxmox VE. This script simplifies the process by downloading and adding one of the available loaders to the VM boot, giving you the option between four different choices:",
|
||||
"loaders": [
|
||||
{
|
||||
"name": "AuxXxilium Arc",
|
||||
"url": "https://github.com/AuxXxilium/arc",
|
||||
"extra": ""
|
||||
},
|
||||
{
|
||||
"name": "RedPill RR",
|
||||
"url": "https://github.com/RROrg/rr",
|
||||
"extra": ""
|
||||
},
|
||||
{
|
||||
"name": "TinyCore RedPill M-shell",
|
||||
"url": "https://github.com/PeterSuh-Q3/tinycore-redpill",
|
||||
"extra": ""
|
||||
}
|
||||
],
|
||||
"customLoader": "Custom Loader – option to use a custom loader if you prefer to modify or create your own configuration",
|
||||
"simplifiesIntro": "The script simplifies the VM creation process by offering the following options:",
|
||||
"simplifies": [
|
||||
"Selection of default or advanced configuration",
|
||||
"Configuration of CPU, RAM, BIOS, and machine type",
|
||||
"Choice between virtual disk or physical disk passthrough"
|
||||
]
|
||||
},
|
||||
"config": {
|
||||
"heading": "Default and Advanced Configuration",
|
||||
"intro": "The script offers two configuration modes:",
|
||||
"defaultHeading": "Default Configuration",
|
||||
"defaultIntro": "If you select default configuration, the script will automatically apply the following values:",
|
||||
"headerParam": "Parameter",
|
||||
"headerValue": "Default Value",
|
||||
"defaultRows": [
|
||||
{
|
||||
"param": "Machine Type",
|
||||
"value": "q35"
|
||||
},
|
||||
{
|
||||
"param": "BIOS Type",
|
||||
"value": "OVMF (UEFI)"
|
||||
},
|
||||
{
|
||||
"param": "CPU Type",
|
||||
"value": "Host"
|
||||
},
|
||||
{
|
||||
"param": "Core Count",
|
||||
"value": "2"
|
||||
},
|
||||
{
|
||||
"param": "RAM Size",
|
||||
"value": "4096 MB"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"value": "vmbr0"
|
||||
},
|
||||
{
|
||||
"param": "MAC Address",
|
||||
"value": "Automatically generated"
|
||||
},
|
||||
{
|
||||
"param": "Start VM on Completion",
|
||||
"value": "No"
|
||||
}
|
||||
],
|
||||
"defaultOutro": "If you want to customize the configuration, select the Advanced Settings option in the menu.",
|
||||
"advancedHeading": "Advanced Configuration",
|
||||
"advancedIntro": "If you select advanced configuration, the script will allow you to customize each parameter:",
|
||||
"headerOptions": "Options",
|
||||
"advancedRows": [
|
||||
{
|
||||
"param": "Machine Type",
|
||||
"options": "q35 or i440fx"
|
||||
},
|
||||
{
|
||||
"param": "BIOS Type",
|
||||
"options": "OVMF (UEFI) or SeaBIOS (Legacy)"
|
||||
},
|
||||
{
|
||||
"param": "CPU Type",
|
||||
"options": "Host or KVM64"
|
||||
},
|
||||
{
|
||||
"param": "Core Count",
|
||||
"options": "Number of CPU cores"
|
||||
},
|
||||
{
|
||||
"param": "RAM Size",
|
||||
"options": "Amount of memory allocated to the VM"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"options": "Network bridge for connection"
|
||||
},
|
||||
{
|
||||
"param": "MAC Address",
|
||||
"options": "Custom MAC address"
|
||||
},
|
||||
{
|
||||
"param": "VLAN",
|
||||
"options": "VLAN tag (if used)"
|
||||
},
|
||||
{
|
||||
"param": "MTU",
|
||||
"options": "Maximum Transmission Unit size"
|
||||
}
|
||||
]
|
||||
},
|
||||
"diskSelection": {
|
||||
"heading": "Disk Selection",
|
||||
"intro": "Once the machine is configured, the script allows you to choose between two types of disks:",
|
||||
"virtualHeading": "Virtual Disk",
|
||||
"virtualItems": [
|
||||
"The script lists the storage options available in Proxmox",
|
||||
"The user selects the disk and size in GB",
|
||||
"The virtual disk is automatically assigned to the VM. If more disks are configured, they will be added as <strong>SATA</strong> (e.g., sata0, sata1, etc.), up to a maximum of 6 virtual disks."
|
||||
],
|
||||
"physicalHeading": "Physical Disk Passthrough",
|
||||
"physicalItems": [
|
||||
"The script detects all available physical disks",
|
||||
"The user selects the physical disk or disks they want to use.",
|
||||
"The physical disk is directly assigned to the VM via passthrough. If more disks are configured, they will be added as <strong>SATA</strong> (e.g., sata0, sata1, etc.), up to a maximum of 6 physical disks."
|
||||
]
|
||||
},
|
||||
"loaderInstall": {
|
||||
"heading": "Loader Installation",
|
||||
"intro1": "The script automatically downloads and extracts the loader from the developer's repository. If the download fails, the script will display an error message.",
|
||||
"intro2Rich": "<strong>AuxXxilium Arc</strong>, <strong>RedPill RR</strong>, and <strong>TinyCore RedPill M-shell</strong>. Downloads and extracts automatically.",
|
||||
"customRich": "For <strong>Custom Loader</strong>, the script searches for files in <code>/var/lib/vz/template/iso</code>. If multiple files are found, you will be prompted to select the desired file.",
|
||||
"uploadIntro": "You can upload custom loaders from the local storage options:",
|
||||
"imageAlt": "Add Custom Loader",
|
||||
"imageCaption": "Add Custom Loader"
|
||||
},
|
||||
"vmCreation": {
|
||||
"heading": "VM Creation",
|
||||
"intro": "Once the loader is downloaded, the script creates the VM using the following commands:",
|
||||
"items": [
|
||||
"<code>qm create</code> – Creates the virtual machine with the configured parameters",
|
||||
"<code>qm importdisk</code> – Imports the boot loader disk to the VM. For greater compatibility the loader is imported as an IDE disk",
|
||||
"<code>qm set</code> – Assigns configuration values such as CPU, RAM, and storage",
|
||||
"<code>qm set -boot</code> – Configures the boot order"
|
||||
]
|
||||
},
|
||||
"stepGuide": {
|
||||
"heading": "Step-by-Step Boot Loader Configuration Guide",
|
||||
"intro": "While all loaders share similarities, each one has its own structure and configuration methods. This section provides a basic guide covering the 6 steps involved in setting up a Synology DSM loader. The exact steps may vary depending on the loader and any changes introduced by the developer. Therefore, understanding these common basic steps is crucial to correctly building and configuring the loader of your choice for proper Synology DSM functionality.",
|
||||
"selectorHeading": "Select your loader type:",
|
||||
"loaderButtons": {
|
||||
"arc": "Arc Loader",
|
||||
"rr": "RR Loader",
|
||||
"tinycore": "TinyCore Loader"
|
||||
}
|
||||
},
|
||||
"steps": [
|
||||
{
|
||||
"id": "step1",
|
||||
"title": "Start the VM and Access the Main Menu",
|
||||
"intro": "Once the VM is created, start it. The first time you boot the VM, you'll access the loader's main menu to select and configure the DSM model you want to build. Once the loader is created, this step will be skipped unless you manually force a reconfiguration from the boot monitor. All loaders also have the option to configure the loader via a web interface.",
|
||||
"loaders": {
|
||||
"arc": [
|
||||
{
|
||||
"htmlBefore": "<strong>Web interface</strong>, To access the web interface, simply open a web browser and enter the IP address shown in the VM's console output. For example, in our case: http://192.169.0.32.",
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_0_1.png",
|
||||
"alt": "Arc Loader Web Interface",
|
||||
"caption": "Arc Loader Web Interface"
|
||||
},
|
||||
{
|
||||
"htmlBefore": "<strong>Terminal interface</strong>, Access it directly from the VM's console output.",
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_1_1.png",
|
||||
"alt": "Arc Loader Terminal Interface",
|
||||
"caption": "Arc Loader Terminal Interface"
|
||||
}
|
||||
],
|
||||
"rr": [
|
||||
{
|
||||
"htmlBefore": "<strong>Web interface</strong>, To access the web interface, simply open a web browser and enter the IP address shown in the VM's console output, followed by port <strong>7681</strong>. For example, in our case: <code>http://192.169.0.33:7681</code>.",
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_0_2.png",
|
||||
"alt": "RR Command Example",
|
||||
"caption": "RR Loader Web Interface"
|
||||
},
|
||||
{
|
||||
"htmlBefore": "<strong>Terminal interface</strong>, Access it directly from the VM's console output by typing <strong>menu.sh</strong> on the screen",
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_1_1.png",
|
||||
"alt": "RR Loader Interface",
|
||||
"caption": "RR Loader Terminal Interface"
|
||||
}
|
||||
],
|
||||
"tinycore": [
|
||||
{
|
||||
"htmlBefore": "<strong>Web interface</strong>, To access the web interface, simply open a web browser and enter the IP address shown in the VM's console output, followed by port <strong>7681</strong>. For example, in our case: <code>http://192.169.0.35:7681</code>.",
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_0_1.png",
|
||||
"alt": "TinyCore Loader Interface",
|
||||
"caption": "TinyCore Loader Web Interface"
|
||||
},
|
||||
{
|
||||
"htmlBefore": "<strong>Terminal interface</strong>, Access it directly from the VM's console output. Keep an eye on the screen, as at some point it may prompt you to press a key to continue or ask if you want to change the language.",
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_1_1.png",
|
||||
"alt": "TinyCore Loader Interface",
|
||||
"caption": "TinyCore Loader Terminal Interface"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "step2",
|
||||
"title": "Select Model",
|
||||
"intro": "After loading the menu, select the Synology DSM model you want to install. Depending on the loader, you may sometimes need to expand the options to see more models.",
|
||||
"outro": "In our example, we'll choose the SA6400 model.",
|
||||
"loaders": {
|
||||
"arc": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_2_1.png",
|
||||
"alt": "Arc Model Selection",
|
||||
"caption": "Arc Model Selection"
|
||||
}
|
||||
],
|
||||
"rr": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_2_1.png",
|
||||
"alt": "RR Model Selection",
|
||||
"caption": "RR Model Selection"
|
||||
}
|
||||
],
|
||||
"tinycore": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_2_1.png",
|
||||
"alt": "TinyCore Model Selection",
|
||||
"caption": "TinyCore Model Selection"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "step3",
|
||||
"title": "Select DSM Version",
|
||||
"intro": "After selecting the model, you need to choose the DSM version you want to install.",
|
||||
"loaders": {
|
||||
"arc": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_3_1.png",
|
||||
"alt": "Arc Version Selection - Step 1",
|
||||
"caption": "Arc Version Selection - Step 1"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_3_2.png",
|
||||
"alt": "Arc Version Selection - Step 2",
|
||||
"caption": "Arc Version Selection - Step 2"
|
||||
}
|
||||
],
|
||||
"rr": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_3_1.png",
|
||||
"alt": "RR Version Selection - Step 1",
|
||||
"caption": "RR Version Selection - Step 1"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_3_2.png",
|
||||
"alt": "RR Version Selection - Step 2",
|
||||
"caption": "RR Version Selection - Step 2"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_3_3.png",
|
||||
"alt": "RR Version Selection - Step 3",
|
||||
"caption": "RR Version Selection - Step 3"
|
||||
}
|
||||
],
|
||||
"tinycore": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_3_1.png",
|
||||
"alt": "TinyCore Version Selection - Step 1",
|
||||
"caption": "TinyCore Version Selection - Step 1"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_3_2.png",
|
||||
"alt": "TinyCore Version Selection - Step 2",
|
||||
"caption": "TinyCore Version Selection - Step 2"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "step4",
|
||||
"title": "Select Addons",
|
||||
"intro": "This step allows you to add additional features or custom configurations to the loader.",
|
||||
"loaders": {
|
||||
"arc": [
|
||||
{
|
||||
"htmlBefore": "<strong>Arc</strong> gives you the option to configure automatically or manually adjust the settings. If automatic configuration is selected, the loader will start applying the necessary settings and will automatically reboot once the process is complete.",
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_4_1.png",
|
||||
"alt": "Arc Auto Configuration",
|
||||
"caption": "Arc Auto Configuration"
|
||||
},
|
||||
{
|
||||
"htmlBefore": "If we choose not to use automatic mode, we enter the menu to configure different options necessary for the loader:",
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_4_2.png",
|
||||
"alt": "Arc Manual Configuration",
|
||||
"caption": "Arc Manual Configuration"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_4_3.png",
|
||||
"alt": "Arc SN/Mac Configuration",
|
||||
"caption": "Arc SN/Mac Configuration"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_4_4.png",
|
||||
"alt": "Arc Sata Portmap",
|
||||
"caption": "Arc Sata Portmap (use the recommended option)"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_4_5.png",
|
||||
"alt": "Arc Addons Selection",
|
||||
"caption": "Arc Addons Selection"
|
||||
}
|
||||
],
|
||||
"rr": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_4_1.png",
|
||||
"alt": "RR Addon Step 1",
|
||||
"caption": "RR Addon Step 1"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_4_2.png",
|
||||
"alt": "RR Addon Step 2",
|
||||
"caption": "RR Addon Step 2 - Press to add addons"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_4_3.png",
|
||||
"alt": "RR Addon Step 3",
|
||||
"caption": "RR Addon Step 3 - Select the one you want by clicking on it. If you want to add more, repeat the process from images 2.4.2 and 2.4.3"
|
||||
}
|
||||
],
|
||||
"tinycore": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_4_1.png",
|
||||
"alt": "TinyCore SN Configuration",
|
||||
"caption": "TinyCore SN Configuration"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_4_2.png",
|
||||
"alt": "TinyCore Random Option",
|
||||
"caption": "TinyCore Random Option - The random option is recommended"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_4_3.png",
|
||||
"alt": "TinyCore MAC Configuration",
|
||||
"caption": "TinyCore MAC Configuration"
|
||||
},
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_4_4.png",
|
||||
"alt": "TinyCore VM MAC",
|
||||
"caption": "TinyCore VM MAC - Choose to use your VM's MAC or a random one"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "step5",
|
||||
"title": "Build the Loader",
|
||||
"intro": "Once you have selected the model, DSM version, and addons, proceed to build the loader. This process might take a few minutes depending on the loader and the selected configuration. To start, select the \"Build the Loader\" option.",
|
||||
"loaders": {
|
||||
"arc": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_5_1.png",
|
||||
"alt": "Arc Build Loader",
|
||||
"caption": "Arc Build Loader"
|
||||
}
|
||||
],
|
||||
"rr": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_5_1.png",
|
||||
"alt": "RR Build Loader",
|
||||
"caption": "RR Build Loader"
|
||||
}
|
||||
],
|
||||
"tinycore": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_5_1.png",
|
||||
"alt": "TinyCore Build Loader",
|
||||
"caption": "TinyCore Build Loader"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "step6",
|
||||
"title": "Boot the Loader",
|
||||
"intro": "Once the loader has been built, it will prompt you to boot. The VM will restart with the configuration you've created and start the DSM installation.",
|
||||
"loaders": {
|
||||
"arc": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/arc/arc_1_6_1.png",
|
||||
"alt": "Arc Boot Loader",
|
||||
"caption": "Arc Boot Loader"
|
||||
}
|
||||
],
|
||||
"rr": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/rr/rr_2_6_1.png",
|
||||
"alt": "RR Boot Loader",
|
||||
"caption": "RR Boot Loader"
|
||||
}
|
||||
],
|
||||
"tinycore": [
|
||||
{
|
||||
"src": "https://macrimi.github.io/ProxMenux/vm/synology/tinycore/tinycore_3_6_1.png",
|
||||
"alt": "TinyCore Boot Loader",
|
||||
"caption": "TinyCore Boot Loader"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"dsmInstall": {
|
||||
"heading": "Starting the DSM Installation",
|
||||
"intro": "Once the loader is booted, you can find your Synology device using:",
|
||||
"afterCode": "Follow the on-screen steps to complete the DSM installation.",
|
||||
"setupAlt": "DSM Setup",
|
||||
"setupCaption": "DSM Setup Screen",
|
||||
"patience": "Please be patient – The process may take a few minutes to complete. The progress percentage will update automatically as the setup progresses. A countdown will start once the installation is nearing completion.",
|
||||
"finishAlt": "Installation Complete",
|
||||
"finishCaption": "Installation Complete"
|
||||
},
|
||||
"tips": {
|
||||
"heading": "Tips",
|
||||
"introItem": "Keep in mind that available options may change depending on the loader version and developer updates. If you encounter issues during the loader creation process, consult the loader documentation:",
|
||||
"docLinks": [
|
||||
{
|
||||
"label": "Arc Documentation",
|
||||
"url": "https://github.com/AuxXxilium/arc"
|
||||
},
|
||||
{
|
||||
"label": "RR Documentation",
|
||||
"url": "https://github.com/RROrg/rr"
|
||||
},
|
||||
{
|
||||
"label": "TinyCore Documentation",
|
||||
"url": "https://github.com/PeterSuh-Q3/tinycore-redpill"
|
||||
}
|
||||
],
|
||||
"olderModels": "Some older DSM models may have issues recognizing disks or the network card. It is recommended to use more recent models.",
|
||||
"updateLabel": "Update:",
|
||||
"updateBody": "Some loaders offer the option to update the loader directly from the menu.",
|
||||
"importantLabel": "Important:",
|
||||
"importantBody": "ProxMenux does not provide support for the different loaders."
|
||||
}
|
||||
}
|
||||
292
web/messages/en/docs/create-vm/system-linux.json
Normal file
292
web/messages/en/docs/create-vm/system-linux.json
Normal file
@@ -0,0 +1,292 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Create VM: System Linux | ProxMenux Documentation",
|
||||
"description": "Create Linux virtual machines on Proxmox VE with ProxMenux. Covers the curated official ISO catalogue (Ubuntu, Debian, Fedora, Arch, Rocky, Mint, openSUSE, Alpine, Kali, Manjaro), the unified storage plan, optional GPU passthrough and post-install tips.",
|
||||
"ogTitle": "Create VM: System Linux | ProxMenux Documentation",
|
||||
"ogDescription": "Create Linux VMs on Proxmox VE with ProxMenux. Curated ISO catalogue, unified storage plan, optional GPU passthrough and post-install tips.",
|
||||
"ogImageAlt": "ProxMenux Linux VM menu"
|
||||
},
|
||||
"header": {
|
||||
"title": "Create VM: System Linux",
|
||||
"description": "Create a Linux VM on Proxmox VE. ProxMenux ships with a curated catalogue of official Linux ISOs ready to download, plus a local-ISO picker, and routes everything through the shared VM wizard, the unified storage plan and the optional GPU passthrough assistant.",
|
||||
"section": "Virtual Machines"
|
||||
},
|
||||
"intro": {
|
||||
"title": "What this script does",
|
||||
"body": "The Linux selector offers two ProxMenux-managed sources of installation media: an official ISO from the curated list (auto-downloaded) or a local ISO you uploaded yourself. Whichever you pick, the rest of the flow is the shared wizard: CPU / RAM / BIOS → storage plan → optional GPU passthrough → VM creation."
|
||||
},
|
||||
"image": {
|
||||
"alt": "ProxMenux Linux installation options",
|
||||
"caption": "Linux installation options"
|
||||
},
|
||||
"config": {
|
||||
"heading": "Default vs Advanced configuration",
|
||||
"intro": "After the ISO is selected, ProxMenux asks whether to use the default VM profile or open the advanced wizard.",
|
||||
"defaultHeading": "Default configuration",
|
||||
"headerParam": "Parameter",
|
||||
"headerValue": "Default value",
|
||||
"defaultRows": [
|
||||
{
|
||||
"param": "Machine type",
|
||||
"valueRich": "<code>q35</code>"
|
||||
},
|
||||
{
|
||||
"param": "BIOS",
|
||||
"value": "OVMF (UEFI)"
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"value": "Host"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
"value": "2"
|
||||
},
|
||||
{
|
||||
"param": "RAM",
|
||||
"value": "4096 MB"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"valueRich": "<code>vmbr0</code>"
|
||||
},
|
||||
{
|
||||
"param": "MAC address",
|
||||
"value": "Auto-generated"
|
||||
},
|
||||
{
|
||||
"param": "Start on completion",
|
||||
"value": "No"
|
||||
}
|
||||
],
|
||||
"advancedHeading": "Advanced configuration",
|
||||
"advancedIntro": "The advanced wizard exposes every parameter individually:",
|
||||
"headerOptions": "Options",
|
||||
"advancedRows": [
|
||||
{
|
||||
"param": "Machine type",
|
||||
"optionsRich": "<code>q35</code> or <code>i440fx</code>"
|
||||
},
|
||||
{
|
||||
"param": "BIOS",
|
||||
"options": "OVMF (UEFI) or SeaBIOS (Legacy)"
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"options": "Host or KVM64"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
"options": "Number of CPU cores"
|
||||
},
|
||||
{
|
||||
"param": "RAM",
|
||||
"options": "Memory allocated to the VM"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"options": "Network bridge"
|
||||
},
|
||||
{
|
||||
"param": "MAC address",
|
||||
"options": "Custom MAC"
|
||||
},
|
||||
{
|
||||
"param": "VLAN",
|
||||
"options": "VLAN tag (optional)"
|
||||
},
|
||||
{
|
||||
"param": "MTU",
|
||||
"options": "MTU size"
|
||||
}
|
||||
]
|
||||
},
|
||||
"storagePlan": {
|
||||
"heading": "Storage plan",
|
||||
"body": "After CPU / RAM, ProxMenux opens the <strong>Storage Plan</strong> menu, where you can combine virtual disks, imported disks and PCI passthrough devices in the same VM, adding items one at a time and finishing when you are done.",
|
||||
"virtualDiskTitle": "a. Add virtual disk",
|
||||
"virtualDiskItems": [
|
||||
"Lists the Proxmox storage volumes available on the host.",
|
||||
"You pick the target storage and the size in GB.",
|
||||
"The disk is attached to the VM as SATA (<code>sata0</code>, <code>sata1</code>, … up to 6)."
|
||||
],
|
||||
"importDiskTitle": "b. Add import disk",
|
||||
"importDiskItems": [
|
||||
"Detects physical disks that are safe to import (system and protected disks are hidden).",
|
||||
"You select one or more disks via a checklist.",
|
||||
"Imported disks are attached as SATA via <code>qm set</code>."
|
||||
],
|
||||
"pciTitle": "c. Add Controller or NVMe (PCI passthrough)",
|
||||
"pciItems": [
|
||||
"Detects SATA/SAS HBAs and NVMe devices on the host and lets you pass an <em>entire controller</em> into the VM. IOMMU must be enabled; the script offers to enable it and reboots if required.",
|
||||
"A confirmation step warns about controller-wide risk (the whole card, including every disk on it, leaves the host).",
|
||||
"The selected PCI devices are attached via <code>qm set hostpciN: …</code>."
|
||||
],
|
||||
"resetTitle": "Reset and finish",
|
||||
"resetBody": "The menu also offers <strong>r</strong> (reset the current selection and start over) and <strong>d</strong> (finish and continue). You cannot finish with an empty plan."
|
||||
},
|
||||
"gpu": {
|
||||
"heading": "Optional GPU passthrough",
|
||||
"body": "After the storage plan, if a compatible GPU is detected on the host ProxMenux offers to launch the GPU passthrough assistant. See <gpuLink>Add GPU to a VM (Passthrough)</gpuLink> for how the assistant works — a host reboot may be required."
|
||||
},
|
||||
"autoFeatures": {
|
||||
"heading": "Automatic VM features",
|
||||
"efiTitle": "EFI disk",
|
||||
"efiBody": "When OVMF (UEFI) is selected, ProxMenux creates a 4 MB EFI system disk on the storage you pick so the firmware has a place to store its variables.",
|
||||
"isoTitle": "ISO mounting",
|
||||
"isoBody": "The installation ISO is attached to <code>ide2</code> as a CD-ROM, ready for first boot.",
|
||||
"guestTitle": "QEMU Guest Agent",
|
||||
"guestBody": "The guest agent channel is enabled in the VM config. You still need to install the agent inside the guest — see the tips below."
|
||||
},
|
||||
"installOptions": {
|
||||
"heading": "Linux installation options",
|
||||
"officialHeading": "Official ISO (traditional install)",
|
||||
"officialBody": "ProxMenux ships with a curated list of official Linux ISOs. Pick one and the script downloads it straight from the upstream mirror into <code>/var/lib/vz/template/iso</code>, then attaches it to the VM.",
|
||||
"officialImageAlt": "Linux distribution selection",
|
||||
"officialImageCaption": "Linux distribution selection",
|
||||
"localHeading": "Local ISO",
|
||||
"localBody": "Uses any Linux ISO already present in <code>/var/lib/vz/template/iso</code>. The script lists every <code>*.iso</code> it finds and lets you pick one.",
|
||||
"localImageAlt": "Local ISO selection menu",
|
||||
"localImageCaption": "Local ISO selection menu",
|
||||
"distros": [
|
||||
{
|
||||
"name": "Ubuntu",
|
||||
"variants": [
|
||||
"25.10 Desktop",
|
||||
"24.04 Desktop",
|
||||
"22.04 Desktop",
|
||||
"20.04 Desktop",
|
||||
"25.10 Server",
|
||||
"24.04 Server",
|
||||
"22.04 Server",
|
||||
"20.04 Server"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Debian",
|
||||
"variants": [
|
||||
"13 Desktop",
|
||||
"12 Desktop",
|
||||
"11 Desktop",
|
||||
"13 Netinst",
|
||||
"12 Netinst",
|
||||
"11 Netinst"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Fedora",
|
||||
"variants": [
|
||||
"Workstation 42"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Arch Linux",
|
||||
"variants": [
|
||||
"latest"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Rocky Linux",
|
||||
"variants": [
|
||||
"9"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Linux Mint",
|
||||
"variants": [
|
||||
"22.1 Cinnamon"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "openSUSE",
|
||||
"variants": [
|
||||
"Leap 15.6"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Alpine Linux",
|
||||
"variants": [
|
||||
"3.21"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Kali Linux",
|
||||
"variants": [
|
||||
"2026.1"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "Manjaro",
|
||||
"variants": [
|
||||
"25.0 GNOME"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"endToEnd": {
|
||||
"heading": "What the script does end-to-end",
|
||||
"items": [
|
||||
"Obtains the Linux ISO (official download or local file).",
|
||||
"Applies the default or advanced CPU / RAM / BIOS / machine-type configuration.",
|
||||
"Opens the storage plan and attaches the selected virtual disks, imported disks and PCI devices.",
|
||||
"Creates the EFI disk when UEFI is selected.",
|
||||
"Mounts the Linux ISO on <code>ide2</code>.",
|
||||
"Sets the boot order (disk first, then ISO).",
|
||||
"Enables the QEMU Guest Agent channel.",
|
||||
"Optionally runs the GPU passthrough assistant.",
|
||||
"Generates a styled HTML description attached to the VM.",
|
||||
"Starts the VM if you chose to."
|
||||
]
|
||||
},
|
||||
"postInstall": {
|
||||
"heading": "Post-install tips",
|
||||
"guestAgentHeading": "Install the QEMU Guest Agent inside the VM",
|
||||
"guestAgentBody": "ProxMenux enables the guest agent channel in the VM config, but the agent itself has to be installed inside the guest. It enables graceful shutdown, filesystem freeze for consistent snapshots and accurate memory reporting in the Proxmox UI.",
|
||||
"debian": "Debian / Ubuntu",
|
||||
"fedora": "Fedora / Rocky / RHEL",
|
||||
"arch": "Arch Linux",
|
||||
"opensuse": "openSUSE",
|
||||
"virtioHeading": "VirtIO support in Linux",
|
||||
"virtioBody": "Modern Linux kernels (2.6.25+) include VirtIO disk and network drivers out of the box, so you can switch the disk interface to <code>virtio</code> or <code>virtio-scsi</code> in the Advanced wizard and the network adapter to <code>virtio</code> without any extra driver step.",
|
||||
"virtioWarnTitle": "Very old distributions",
|
||||
"virtioWarnBody": "If you are installing something predating the 2.6.25 kernel, VirtIO modules may not be available at install time. In that case keep SATA / SCSI or provide a driver disk.",
|
||||
"trimHeading": "Enable TRIM / discard on SSD-backed storage",
|
||||
"trimBody": "When the VM sits on SSD-backed Proxmox storage and the disk was attached with the <code>discard</code> flag, you can forward trim commands from inside the guest. Two options:",
|
||||
"trimItems": [
|
||||
"Run <code>fstrim -av</code> periodically (or enable the <code>fstrim.timer</code> unit on systemd distributions).",
|
||||
"Or mount filesystems with the <code>discard</code> option in <code>/etc/fstab</code>."
|
||||
],
|
||||
"balloonHeading": "Memory ballooning",
|
||||
"balloonBody": "The <code>virtio_balloon</code> driver ships with modern Linux kernels. Proxmox uses it to reclaim unused memory from the VM and show accurate utilisation in the UI — no guest-side configuration required."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
"items": [
|
||||
{
|
||||
"href": "/docs/disk-manager/import-disk-image-vm",
|
||||
"label": "Import Disk Image to VM",
|
||||
"tail": " — attach an existing Linux .qcow2 / .img / .raw to a fresh VM."
|
||||
},
|
||||
{
|
||||
"href": "/docs/utils/import-vm",
|
||||
"label": "Import VM from OVA / OVF",
|
||||
"tail": " — bring in a Linux VM exported from VMware / VirtualBox / Proxmox."
|
||||
},
|
||||
{
|
||||
"href": "/docs/hardware/gpu-vm-passthrough",
|
||||
"label": "Add GPU to VM (Passthrough)",
|
||||
"tail": " — for Linux VMs that need GPU acceleration."
|
||||
},
|
||||
{
|
||||
"href": "/docs/help-info/vm-ct-commands",
|
||||
"label": "VM and CT Management commands",
|
||||
"tail": " — qm CLI reference."
|
||||
},
|
||||
{
|
||||
"href": "/docs/create-vm",
|
||||
"label": "Create VM overview",
|
||||
"tail": "."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
138
web/messages/en/docs/create-vm/system-nas/index.json
Normal file
138
web/messages/en/docs/create-vm/system-nas/index.json
Normal file
@@ -0,0 +1,138 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Create VM: System NAS | ProxMenux Documentation",
|
||||
"description": "Create NAS virtual machines on Proxmox VE with ProxMenux. Supports Synology DSM (loader), TrueNAS SCALE / CORE, OpenMediaVault, XigmaNAS, Rockstor and ZimaOS. Umbrel OS is available via community script.",
|
||||
"ogTitle": "Create VM: System NAS | ProxMenux Documentation",
|
||||
"ogDescription": "Create NAS virtual machines on Proxmox VE with ProxMenux. Supports Synology DSM (loader), TrueNAS SCALE / CORE, OpenMediaVault, XigmaNAS, Rockstor and ZimaOS.",
|
||||
"ogImageAlt": "ProxMenux System NAS Menu"
|
||||
},
|
||||
"header": {
|
||||
"title": "Create VM: System NAS",
|
||||
"description": "ProxMenux supports seven NAS operating systems as dedicated VMs, plus an optional Umbrel OS path via a community script. Most systems share the same auto-ISO flow; Synology DSM uses a specialised loader wizard.",
|
||||
"section": "Virtual Machines"
|
||||
},
|
||||
"intro": {
|
||||
"title": "How the NAS selector works",
|
||||
"body": "The NAS selector detects the latest stable release of each appliance (querying its upstream mirror), downloads the ISO — or builds the VM from a pre-packaged image — and then hands over to the generic ProxMenux VM wizard for CPU, RAM, disk and network configuration."
|
||||
},
|
||||
"image": {
|
||||
"alt": "ProxMenux System NAS selector",
|
||||
"caption": "System NAS selector"
|
||||
},
|
||||
"flowBadges": {
|
||||
"loader": "Loader flow",
|
||||
"auto-iso": "Auto-ISO flow",
|
||||
"dedicated": "Dedicated script"
|
||||
},
|
||||
"labels": {
|
||||
"base": "Base",
|
||||
"fileSystem": "Filesystem",
|
||||
"viewDetails": "View details"
|
||||
},
|
||||
"supported": {
|
||||
"heading": "Supported NAS systems",
|
||||
"cards": [
|
||||
{
|
||||
"name": "Synology DSM",
|
||||
"tagline": "DiskStation Manager with the ARC / RR loader. Requires configuring the loader before first boot.",
|
||||
"icon": "HardDrive",
|
||||
"base": "Linux (custom)",
|
||||
"fileSystem": "Btrfs, ext4",
|
||||
"href": "/docs/create-vm/system-nas/synology",
|
||||
"flow": "loader"
|
||||
},
|
||||
{
|
||||
"name": "TrueNAS SCALE",
|
||||
"tagline": "Debian-based TrueNAS with Docker / Kubernetes apps and ZFS as primary filesystem.",
|
||||
"icon": "Database",
|
||||
"base": "Debian Linux",
|
||||
"fileSystem": "ZFS",
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others#truenas-scale",
|
||||
"flow": "auto-iso"
|
||||
},
|
||||
{
|
||||
"name": "TrueNAS CORE",
|
||||
"tagline": "FreeBSD-based TrueNAS. Enterprise-grade ZFS storage with jails and plugins.",
|
||||
"icon": "Database",
|
||||
"base": "FreeBSD",
|
||||
"fileSystem": "ZFS",
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others#truenas-core",
|
||||
"flow": "auto-iso"
|
||||
},
|
||||
{
|
||||
"name": "OpenMediaVault",
|
||||
"tagline": "Lightweight Debian-based NAS with a modular plugin architecture. Great for older hardware.",
|
||||
"icon": "Server",
|
||||
"base": "Debian Linux",
|
||||
"fileSystem": "ext4, XFS, Btrfs",
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others#openmediavault",
|
||||
"flow": "auto-iso"
|
||||
},
|
||||
{
|
||||
"name": "XigmaNAS",
|
||||
"tagline": "FreeBSD-based NAS — the original successor to FreeNAS, focused on ZFS and simplicity.",
|
||||
"icon": "Database",
|
||||
"base": "FreeBSD",
|
||||
"fileSystem": "ZFS, UFS",
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others#xigmanas",
|
||||
"flow": "auto-iso"
|
||||
},
|
||||
{
|
||||
"name": "Rockstor",
|
||||
"tagline": "openSUSE-based NAS built around Btrfs. Rock-ons (Docker apps) extend functionality.",
|
||||
"icon": "HardDrive",
|
||||
"base": "openSUSE Leap",
|
||||
"fileSystem": "Btrfs",
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others#rockstor",
|
||||
"flow": "auto-iso"
|
||||
},
|
||||
{
|
||||
"name": "ZimaOS",
|
||||
"tagline": "Lightweight NAS OS focused on media, Docker apps and home automation. Uses its own installer.",
|
||||
"icon": "MonitorIcon",
|
||||
"base": "Debian / CasaOS",
|
||||
"fileSystem": "ext4",
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others#zimaos",
|
||||
"flow": "dedicated"
|
||||
}
|
||||
]
|
||||
},
|
||||
"umbrel": {
|
||||
"title": "Community option: Umbrel OS",
|
||||
"bodyRich": "The 8th entry in the NAS menu is <strong>Umbrel OS</strong>. It runs a <umbrelLink>community-scripts installer</umbrelLink> maintained outside ProxMenux, so it is not documented here. The installer handles the entire lifecycle and prints its default credentials at the end."
|
||||
},
|
||||
"zfsMem": {
|
||||
"title": "ZFS memory rule of thumb",
|
||||
"bodyRich": "If you pick a ZFS-based NAS (TrueNAS, XigmaNAS), allocate at least <strong>8 GB RAM</strong> to the VM — ZFS uses free memory as ARC cache and performance degrades noticeably below that. Rockstor (Btrfs) and OMV (ext4) are far less memory-hungry."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
"items": [
|
||||
{
|
||||
"href": "/docs/create-vm/system-nas/synology",
|
||||
"label": "Synology VM",
|
||||
"tail": " — dedicated installer for Synology DSM (Xpenology) on Proxmox."
|
||||
},
|
||||
{
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others",
|
||||
"label": "Other System NAS",
|
||||
"tail": " — TrueNAS, OpenMediaVault, Rockstor, XigmaNAS and similar."
|
||||
},
|
||||
{
|
||||
"href": "/docs/disk-manager/import-disk-vm",
|
||||
"label": "Import Disk to VM",
|
||||
"tail": " — pass real physical disks to the NAS VM (recommended over virtual disks for production)."
|
||||
},
|
||||
{
|
||||
"href": "/docs/help-info/zfs-commands",
|
||||
"label": "ZFS Management commands",
|
||||
"tail": " — useful if your NAS distribution uses ZFS underneath."
|
||||
},
|
||||
{
|
||||
"href": "/docs/create-vm",
|
||||
"label": "Create VM overview",
|
||||
"tail": "."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
400
web/messages/en/docs/create-vm/system-nas/synology.json
Normal file
400
web/messages/en/docs/create-vm/system-nas/synology.json
Normal file
@@ -0,0 +1,400 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Create VM: Synology DSM | ProxMenux Documentation",
|
||||
"description": "Create a Synology DSM virtual machine on Proxmox VE. ProxMenux downloads the loader of your choice (Arc, RR, TinyCore M-shell or a custom one), imports it as the VM's boot disk and prepares CPU, RAM and storage through the default or advanced wizard.",
|
||||
"ogTitle": "Create VM: Synology DSM | ProxMenux Documentation",
|
||||
"ogDescription": "Create a Synology DSM virtual machine on Proxmox VE with ProxMenux."
|
||||
},
|
||||
"header": {
|
||||
"title": "Create VM: Synology DSM",
|
||||
"description": "Create a Synology DSM virtual machine on Proxmox VE. ProxMenux downloads the loader of your choice (Arc, RR, TinyCore M-shell or a custom one), imports it as the VM's boot disk and prepares CPU, RAM and storage through the default or advanced wizard.",
|
||||
"section": "Virtual Machines · NAS"
|
||||
},
|
||||
"loaderLabels": {
|
||||
"arc": "Arc Loader",
|
||||
"rr": "RR Loader",
|
||||
"tinycore": "TinyCore Loader"
|
||||
},
|
||||
"whatThisDoes": {
|
||||
"title": "What this does",
|
||||
"bodyRich": "ProxMenux automates the VM-side of a Synology DSM install: it downloads one of the supported loaders, imports it into a new VM as an IDE boot disk, and applies the CPU / RAM / network / storage you pick. The rest — building the loader, choosing the DSM model, installing DSM — happens <strong>inside the VM</strong>, driven by the loader's own web or terminal interface. Those steps are community-maintained and change often, so this page gives you a working baseline."
|
||||
},
|
||||
"supportedLoaders": {
|
||||
"heading": "Supported loaders",
|
||||
"intro": "The script lets you choose between four loader sources:",
|
||||
"loaders": [
|
||||
{
|
||||
"name": "AuxXxilium Arc",
|
||||
"url": "https://github.com/AuxXxilium/arc"
|
||||
},
|
||||
{
|
||||
"name": "RedPill RR",
|
||||
"url": "https://github.com/RROrg/rr"
|
||||
},
|
||||
{
|
||||
"name": "TinyCore RedPill M-shell",
|
||||
"url": "https://github.com/PeterSuh-Q3/tinycore-redpill"
|
||||
}
|
||||
],
|
||||
"customRich": "<strong>Custom Loader</strong> — drop your own loader image into <code>/var/lib/vz/template/iso</code> and the script will pick it up."
|
||||
},
|
||||
"config": {
|
||||
"heading": "Default vs Advanced configuration",
|
||||
"intro": "When you run the script it asks whether to use the ProxMenux default VM profile or open the advanced wizard. Default values are tuned for DSM and work for most installs.",
|
||||
"defaultHeading": "Default configuration",
|
||||
"headerParam": "Parameter",
|
||||
"headerValue": "Default value",
|
||||
"defaultRowsRich": [
|
||||
{
|
||||
"param": "Machine type",
|
||||
"valueRich": "<code>q35</code>"
|
||||
},
|
||||
{
|
||||
"param": "BIOS",
|
||||
"valueRich": "OVMF (UEFI)"
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"valueRich": "Host"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
"valueRich": "2"
|
||||
},
|
||||
{
|
||||
"param": "RAM",
|
||||
"valueRich": "4096 MB"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"valueRich": "<code>vmbr0</code>"
|
||||
},
|
||||
{
|
||||
"param": "MAC address",
|
||||
"valueRich": "Auto-generated"
|
||||
},
|
||||
{
|
||||
"param": "Start on completion",
|
||||
"valueRich": "No"
|
||||
}
|
||||
],
|
||||
"advancedHeading": "Advanced configuration",
|
||||
"advancedIntro": "The advanced wizard exposes every knob. You can freely change any of these:",
|
||||
"headerOptions": "Options",
|
||||
"advancedRowsRich": [
|
||||
{
|
||||
"param": "Machine type",
|
||||
"optionsRich": "<code>q35</code> or <code>i440fx</code>"
|
||||
},
|
||||
{
|
||||
"param": "BIOS",
|
||||
"optionsRich": "OVMF (UEFI) or SeaBIOS (Legacy)"
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"optionsRich": "Host or KVM64"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
"optionsRich": "Number of CPU cores"
|
||||
},
|
||||
{
|
||||
"param": "RAM",
|
||||
"optionsRich": "Memory allocated to the VM"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"optionsRich": "Network bridge"
|
||||
},
|
||||
{
|
||||
"param": "MAC address",
|
||||
"optionsRich": "Custom MAC"
|
||||
},
|
||||
{
|
||||
"param": "VLAN",
|
||||
"optionsRich": "VLAN tag (optional)"
|
||||
},
|
||||
{
|
||||
"param": "MTU",
|
||||
"optionsRich": "MTU size"
|
||||
}
|
||||
]
|
||||
},
|
||||
"storagePlan": {
|
||||
"heading": "Storage plan",
|
||||
"introRich": "After the CPU / RAM step, ProxMenux opens the <strong>Storage Plan</strong> menu, where you can <strong>combine</strong> virtual disks, imported disks and PCI passthrough devices in the same VM, adding items one at a time and finishing when you are done.",
|
||||
"virtualHeading": "a. Add virtual disk",
|
||||
"virtualItemsRich": [
|
||||
"Lists the Proxmox storage volumes available on the host.",
|
||||
"You pick the target storage and the size in GB.",
|
||||
"The disk is attached to the VM as SATA (<code>sata0</code>, <code>sata1</code>, … up to 6)."
|
||||
],
|
||||
"importHeading": "b. Add import disk",
|
||||
"importItemsRich": [
|
||||
"Detects physical disks that are safe to import (system and protected disks are hidden).",
|
||||
"You select one or more disks via a checklist.",
|
||||
"Imported disks are attached as SATA via <code>qm set</code>."
|
||||
],
|
||||
"pciHeading": "c. Add Controller or NVMe (PCI passthrough)",
|
||||
"pciItemsRich": [
|
||||
"Detects SATA/SAS HBAs and NVMe devices on the host and lets you pass an <em>entire controller</em> into the VM. IOMMU must be enabled; the script offers to enable it and reboots if required.",
|
||||
"A confirmation step warns about controller-wide risk (the whole card, including every disk on it, leaves the host).",
|
||||
"The selected PCI devices are attached via <code>qm set hostpciN: …</code>."
|
||||
],
|
||||
"resetCalloutTitle": "Reset and finish",
|
||||
"resetCalloutBodyRich": "The menu also offers <strong>r</strong> (reset the current selection and start over) and <strong>d</strong> (finish and continue). You cannot finish with an empty plan — Synology needs at least one disk to install DSM on."
|
||||
},
|
||||
"gpu": {
|
||||
"heading": "Optional GPU passthrough",
|
||||
"bodyRich": "After the storage plan, if the script detects a compatible GPU on the host it asks whether you want to pass it to this VM. See <link>Add GPU to a VM (Passthrough)</link> for how the assistant works — a host reboot may be required."
|
||||
},
|
||||
"loaderInstall": {
|
||||
"heading": "Loader installation",
|
||||
"intro1Rich": "<strong>Arc</strong>, <strong>RR</strong> and <strong>TinyCore M-shell</strong> are downloaded and extracted automatically from their upstream GitHub repositories. If the download fails the script aborts with a clear message.",
|
||||
"intro2Rich": "For the <strong>Custom Loader</strong> option the script scans <code>/var/lib/vz/template/iso</code>. If more than one candidate is found you are prompted to pick the one you want.",
|
||||
"uploadIntro": "You can upload custom loaders from Proxmox local storage:",
|
||||
"imageAlt": "Add custom loader",
|
||||
"imageCaption": "Add custom loader"
|
||||
},
|
||||
"vmCreation": {
|
||||
"heading": "VM creation — what the script runs",
|
||||
"introRich": "Once you confirm the loader, ProxMenux runs the equivalent of these <code>qm</code> commands:",
|
||||
"itemsRich": [
|
||||
"<code>qm create</code> — creates the VM with the selected CPU, RAM, BIOS and machine type.",
|
||||
"<code>qm importdisk</code> — imports the loader as an <strong>IDE</strong> disk (maximum compatibility).",
|
||||
"<code>qm set sataN: …</code> — attaches virtual disks and imported disks from the storage plan, plus the network interface.",
|
||||
"<code>qm set hostpciN: …</code> — attaches any Controller / NVMe devices selected for PCI passthrough.",
|
||||
"<code>qm set --boot</code> — sets the loader as the first boot device."
|
||||
]
|
||||
},
|
||||
"stepByStep": {
|
||||
"heading": "Step-by-step loader configuration",
|
||||
"intro": "All loaders follow the same high-level pattern — start the VM, pick a model, pick a DSM version, pick add-ons, build, boot — but the screens and menus differ. The guide below walks through the six shared steps with screenshots for each loader. Exact options may change with new loader releases.",
|
||||
"warnCalloutTitle": "Loaders are not maintained by ProxMenux",
|
||||
"warnCalloutBody": "Arc, RR and TinyCore are community projects with their own release cadence. If a step looks different from the screenshots below, the loader has probably updated — check the loader's own documentation (links at the bottom of this page)."
|
||||
},
|
||||
"stepBadge": "Step",
|
||||
"step1": {
|
||||
"title": "Start the VM and access the main menu",
|
||||
"intro": "Once the VM is created, start it. The first boot takes you to the loader's configuration interface where you pick and build the DSM model you want. After the loader has been built, subsequent boots skip this step unless you force a reconfiguration from the loader's own boot monitor. All three loaders support both a terminal UI and a web UI.",
|
||||
"arc": {
|
||||
"webRich": "<strong>Web interface.</strong> Open a browser and go to the IP shown in the VM console (in our example: <code>http://192.168.0.32</code>).",
|
||||
"webAlt": "Arc loader web interface",
|
||||
"webCaption": "Arc loader web interface",
|
||||
"termRich": "<strong>Terminal interface.</strong> Use it directly from the VM console output.",
|
||||
"termAlt": "Arc loader terminal interface",
|
||||
"termCaption": "Arc loader terminal interface"
|
||||
},
|
||||
"rr": {
|
||||
"webRich": "<strong>Web interface.</strong> Open a browser and go to the IP shown in the VM console followed by port <strong>7681</strong> (example: <code>http://192.168.0.33:7681</code>).",
|
||||
"webAlt": "RR loader web interface",
|
||||
"webCaption": "RR loader web interface",
|
||||
"termRich": "<strong>Terminal interface.</strong> In the VM console type <code>menu.sh</code> to open it.",
|
||||
"termAlt": "RR loader terminal interface",
|
||||
"termCaption": "RR loader terminal interface"
|
||||
},
|
||||
"tinycore": {
|
||||
"webRich": "<strong>Web interface.</strong> Open a browser and go to the IP shown in the VM console followed by port <strong>7681</strong> (example: <code>http://192.168.0.35:7681</code>).",
|
||||
"webAlt": "TinyCore loader web interface",
|
||||
"webCaption": "TinyCore loader web interface",
|
||||
"termRich": "<strong>Terminal interface.</strong> Use it from the VM console. Keep an eye on it — at some point it may prompt you to press a key to continue or to change the language.",
|
||||
"termAlt": "TinyCore loader terminal interface",
|
||||
"termCaption": "TinyCore loader terminal interface"
|
||||
}
|
||||
},
|
||||
"step2": {
|
||||
"title": "Select model",
|
||||
"introRich": "Pick the Synology DSM model you want to install. Depending on the loader you may need to expand the options to see the full list. In the screenshots below we use the <strong>SA6400</strong> model as an example.",
|
||||
"arc": {
|
||||
"alt": "Arc model selection",
|
||||
"caption": "Arc model selection"
|
||||
},
|
||||
"rr": {
|
||||
"alt": "RR model selection",
|
||||
"caption": "RR model selection"
|
||||
},
|
||||
"tinycore": {
|
||||
"alt": "TinyCore model selection",
|
||||
"caption": "TinyCore model selection"
|
||||
}
|
||||
},
|
||||
"step3": {
|
||||
"title": "Select DSM version",
|
||||
"intro": "After picking the model, choose the DSM version to install.",
|
||||
"arc": [
|
||||
{
|
||||
"alt": "Arc version — step 1",
|
||||
"caption": "Arc version selection — step 1"
|
||||
},
|
||||
{
|
||||
"alt": "Arc version — step 2",
|
||||
"caption": "Arc version selection — step 2"
|
||||
}
|
||||
],
|
||||
"rr": [
|
||||
{
|
||||
"alt": "RR version — step 1",
|
||||
"caption": "RR version selection — step 1"
|
||||
},
|
||||
{
|
||||
"alt": "RR version — step 2",
|
||||
"caption": "RR version selection — step 2"
|
||||
},
|
||||
{
|
||||
"alt": "RR version — step 3",
|
||||
"caption": "RR version selection — step 3"
|
||||
}
|
||||
],
|
||||
"tinycore": [
|
||||
{
|
||||
"alt": "TinyCore version — step 1",
|
||||
"caption": "TinyCore version selection — step 1"
|
||||
},
|
||||
{
|
||||
"alt": "TinyCore version — step 2",
|
||||
"caption": "TinyCore version selection — step 2"
|
||||
}
|
||||
]
|
||||
},
|
||||
"step4": {
|
||||
"title": "Select addons",
|
||||
"intro": "This step lets you add extra features or custom configuration to the loader.",
|
||||
"arc": {
|
||||
"autoRich": "<strong>Arc</strong> offers an automatic mode (recommended) and a manual mode. In automatic mode the loader applies sensible defaults and reboots on its own when done.",
|
||||
"autoAlt": "Arc auto configuration",
|
||||
"autoCaption": "Arc auto configuration",
|
||||
"manualRich": "If you pick manual, you step through the options one by one:",
|
||||
"manualAlt": "Arc manual configuration",
|
||||
"manualCaption": "Arc manual configuration",
|
||||
"snMacAlt": "Arc SN/MAC",
|
||||
"snMacCaption": "Arc SN / MAC configuration",
|
||||
"portmapAlt": "Arc SATA portmap",
|
||||
"portmapCaption": "Arc SATA portmap (use the recommended option)",
|
||||
"addonsAlt": "Arc addons",
|
||||
"addonsCaption": "Arc addons selection"
|
||||
},
|
||||
"rr": [
|
||||
{
|
||||
"alt": "RR addon — step 1",
|
||||
"caption": "RR addon — step 1"
|
||||
},
|
||||
{
|
||||
"alt": "RR addon — step 2",
|
||||
"caption": "RR addon — step 2: press to add an addon"
|
||||
},
|
||||
{
|
||||
"alt": "RR addon — step 3",
|
||||
"caption": "RR addon — step 3: click the addon you want. Repeat the previous two screenshots to add more."
|
||||
}
|
||||
],
|
||||
"tinycore": [
|
||||
{
|
||||
"alt": "TinyCore SN configuration",
|
||||
"caption": "TinyCore SN configuration"
|
||||
},
|
||||
{
|
||||
"alt": "TinyCore random option",
|
||||
"caption": "TinyCore random option (recommended)"
|
||||
},
|
||||
{
|
||||
"alt": "TinyCore MAC configuration",
|
||||
"caption": "TinyCore MAC configuration"
|
||||
},
|
||||
{
|
||||
"alt": "TinyCore VM MAC",
|
||||
"caption": "TinyCore — pick the VM's MAC or a random one"
|
||||
}
|
||||
]
|
||||
},
|
||||
"step5": {
|
||||
"title": "Build the loader",
|
||||
"introRich": "With the model, DSM version and addons chosen, pick <strong>Build the Loader</strong>. This can take a few minutes depending on the loader and the selected options.",
|
||||
"arc": {
|
||||
"alt": "Arc build loader",
|
||||
"caption": "Arc — build loader"
|
||||
},
|
||||
"rr": {
|
||||
"alt": "RR build loader",
|
||||
"caption": "RR — build loader"
|
||||
},
|
||||
"tinycore": {
|
||||
"alt": "TinyCore build loader",
|
||||
"caption": "TinyCore — build loader"
|
||||
}
|
||||
},
|
||||
"step6": {
|
||||
"title": "Boot the loader",
|
||||
"intro": "Once the loader is built, the VM reboots with the configuration you created and DSM installation begins.",
|
||||
"arc": {
|
||||
"alt": "Arc boot loader",
|
||||
"caption": "Arc — boot loader"
|
||||
},
|
||||
"rr": {
|
||||
"alt": "RR boot loader",
|
||||
"caption": "RR — boot loader"
|
||||
},
|
||||
"tinycore": {
|
||||
"alt": "TinyCore boot loader",
|
||||
"caption": "TinyCore — boot loader"
|
||||
}
|
||||
},
|
||||
"dsmInstall": {
|
||||
"heading": "Starting the DSM installation",
|
||||
"intro": "Once the loader has booted you can discover your DSM VM by opening:",
|
||||
"afterCode": "Follow the on-screen steps to complete the DSM installation.",
|
||||
"setupAlt": "DSM setup",
|
||||
"setupCaption": "DSM setup screen",
|
||||
"patience": "Be patient — the process can take several minutes. Progress updates automatically and a countdown appears as installation nears completion.",
|
||||
"finishAlt": "Installation complete",
|
||||
"finishCaption": "Installation complete"
|
||||
},
|
||||
"tips": {
|
||||
"heading": "Tips",
|
||||
"recentTitle": "Use recent DSM models",
|
||||
"recentBody": "Some older DSM models have trouble recognising disks or the network card. Prefer recent models (e.g. SA6400) for a smoother first-boot experience.",
|
||||
"updateTitle": "Updating the loader",
|
||||
"updateBody": "Some loaders offer the option to update themselves directly from their configuration menu — you don't have to destroy and recreate the VM.",
|
||||
"warnTitle": "ProxMenux does not support the loaders",
|
||||
"warnBody": "ProxMenux automates the VM side. Loader issues (model not found, add-on failing to install, DSM refusing to boot) are out of scope here — use each loader's own issue tracker and documentation.",
|
||||
"docsHeading": "Loader documentation",
|
||||
"docLinks": [
|
||||
{
|
||||
"label": "Arc documentation",
|
||||
"url": "https://github.com/AuxXxilium/arc"
|
||||
},
|
||||
{
|
||||
"label": "RR documentation",
|
||||
"url": "https://github.com/RROrg/rr"
|
||||
},
|
||||
{
|
||||
"label": "TinyCore documentation",
|
||||
"url": "https://github.com/PeterSuh-Q3/tinycore-redpill"
|
||||
}
|
||||
]
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
"itemsRich": [
|
||||
{
|
||||
"href": "/docs/create-vm/system-nas",
|
||||
"label": "System NAS overview",
|
||||
"tail": " — comparison of Synology vs TrueNAS / OMV / Rockstor / XigmaNAS."
|
||||
},
|
||||
{
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others",
|
||||
"label": "Other System NAS",
|
||||
"tail": " — non-Synology NAS distributions."
|
||||
},
|
||||
{
|
||||
"href": "/docs/disk-manager/import-disk-vm",
|
||||
"label": "Import Disk to VM",
|
||||
"tail": " — pass real disks to the Synology VM (recommended for storage performance)."
|
||||
},
|
||||
{
|
||||
"href": "/docs/create-vm",
|
||||
"label": "Create VM overview",
|
||||
"tail": "."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
297
web/messages/en/docs/create-vm/system-nas/system-nas-others.json
Normal file
297
web/messages/en/docs/create-vm/system-nas/system-nas-others.json
Normal file
@@ -0,0 +1,297 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Create VM: Other NAS Systems | ProxMenux Documentation",
|
||||
"description": "Create TrueNAS SCALE, TrueNAS CORE, OpenMediaVault, XigmaNAS, Rockstor and ZimaOS virtual machines on Proxmox VE with ProxMenux. Covers default / advanced configuration, the new storage plan, optional GPU passthrough and per-system recommended specs.",
|
||||
"ogTitle": "Create VM: Other NAS Systems | ProxMenux Documentation",
|
||||
"ogDescription": "Create TrueNAS SCALE / CORE, OpenMediaVault, XigmaNAS, Rockstor and ZimaOS VMs on Proxmox VE with ProxMenux.",
|
||||
"ogImageAlt": "ProxMenux NAS selector"
|
||||
},
|
||||
"header": {
|
||||
"title": "Create VM: Other NAS Systems",
|
||||
"description": "ProxMenux can create a ready-to-install VM for TrueNAS SCALE, TrueNAS CORE, OpenMediaVault, XigmaNAS, Rockstor and ZimaOS. This page covers the shared creation flow (default / advanced configuration, the new storage plan, optional GPU passthrough) plus per-system notes and recommended specs.",
|
||||
"section": "Virtual Machines · NAS"
|
||||
},
|
||||
"intro": {
|
||||
"title": "How these systems are created",
|
||||
"bodyRich": "All six systems share the same ProxMenux wizard. The NAS selector picks the matching installer (auto-detecting the latest stable version for TrueNAS, OMV, XigmaNAS and Rockstor) and then hands over to the generic VM configurator and the storage plan. ZimaOS uses its own installer script (<code>vm/zimaos.sh</code>) but follows the same CPU / RAM / storage / optional-GPU sequence."
|
||||
},
|
||||
"config": {
|
||||
"heading": "Default vs Advanced configuration",
|
||||
"intro": "When a NAS is selected, ProxMenux asks whether to use the default VM profile or open the advanced wizard. The defaults are tuned for NAS workloads — more RAM than a plain Linux VM because ZFS-based systems need it for the ARC cache.",
|
||||
"defaultHeading": "Default configuration",
|
||||
"headerParam": "Parameter",
|
||||
"headerValue": "Default value",
|
||||
"defaultRowsRich": [
|
||||
{
|
||||
"param": "Machine type",
|
||||
"valueRich": "<code>q35</code>"
|
||||
},
|
||||
{
|
||||
"param": "BIOS",
|
||||
"valueRich": "OVMF (UEFI)<note> — SeaBIOS for OpenMediaVault</note>"
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"valueRich": "Host"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
"valueRich": "2"
|
||||
},
|
||||
{
|
||||
"param": "RAM",
|
||||
"valueRich": "8192 MB<note> — 4096 MB for ZimaOS</note>"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"valueRich": "<code>vmbr0</code>"
|
||||
},
|
||||
{
|
||||
"param": "MAC address",
|
||||
"valueRich": "Auto-generated"
|
||||
},
|
||||
{
|
||||
"param": "Start on completion",
|
||||
"valueRich": "No"
|
||||
}
|
||||
],
|
||||
"advancedHeading": "Advanced configuration",
|
||||
"advancedIntro": "The advanced wizard exposes every parameter individually:",
|
||||
"headerOptions": "Options",
|
||||
"advancedRowsRich": [
|
||||
{
|
||||
"param": "Machine type",
|
||||
"optionsRich": "<code>q35</code> or <code>i440fx</code>"
|
||||
},
|
||||
{
|
||||
"param": "BIOS",
|
||||
"optionsRich": "OVMF (UEFI) or SeaBIOS (Legacy)"
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"optionsRich": "Host or KVM64"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
"optionsRich": "Number of CPU cores"
|
||||
},
|
||||
{
|
||||
"param": "RAM",
|
||||
"optionsRich": "Memory allocated to the VM"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"optionsRich": "Network bridge"
|
||||
},
|
||||
{
|
||||
"param": "MAC address",
|
||||
"optionsRich": "Custom MAC"
|
||||
},
|
||||
{
|
||||
"param": "VLAN",
|
||||
"optionsRich": "VLAN tag (optional)"
|
||||
},
|
||||
{
|
||||
"param": "MTU",
|
||||
"optionsRich": "MTU size"
|
||||
}
|
||||
],
|
||||
"zfsCalloutTitle": "ZFS and RAM",
|
||||
"zfsCalloutBody": "TrueNAS SCALE / CORE and XigmaNAS are ZFS-based. ZFS uses free memory as ARC cache, so the 8 GB default is a minimum — bump it to 16 GB or more if you plan to store anything meaningful. OMV (ext4/XFS), Rockstor (Btrfs) and ZimaOS are far less memory-hungry."
|
||||
},
|
||||
"storagePlan": {
|
||||
"heading": "Storage plan",
|
||||
"intro": "After CPU / RAM, ProxMenux opens the Storage Plan menu, where you can combine virtual disks, imported disks and PCI passthrough devices in the same VM, adding items one at a time and finishing when you are done.",
|
||||
"virtualHeading": "a. Add virtual disk",
|
||||
"virtualItemsRich": [
|
||||
"Lists the Proxmox storage volumes available on the host.",
|
||||
"You pick the target storage and the size in GB.",
|
||||
"The disk is attached to the VM as SATA (<code>sata0</code>, <code>sata1</code>, … up to 6)."
|
||||
],
|
||||
"importHeading": "b. Add import disk",
|
||||
"importItemsRich": [
|
||||
"Detects physical disks that are safe to import (system and protected disks are hidden).",
|
||||
"You select one or more disks via a checklist.",
|
||||
"Imported disks are attached as SATA via <code>qm set</code>."
|
||||
],
|
||||
"pciHeading": "c. Add Controller or NVMe (PCI passthrough)",
|
||||
"pciItemsRich": [
|
||||
"Detects SATA/SAS HBAs and NVMe devices on the host and lets you pass an <em>entire controller</em> into the VM. IOMMU must be enabled; the script offers to enable it and reboots if required.",
|
||||
"A confirmation step warns about controller-wide risk (the whole card, including every disk on it, leaves the host).",
|
||||
"The selected PCI devices are attached via <code>qm set hostpciN: …</code>."
|
||||
],
|
||||
"resetCalloutTitle": "Reset and finish",
|
||||
"resetCalloutBodyRich": "The menu also offers <strong>r</strong> (reset the current selection and start over) and <strong>d</strong> (finish and continue). You cannot finish with an empty plan."
|
||||
},
|
||||
"gpu": {
|
||||
"heading": "Optional GPU passthrough",
|
||||
"bodyRich": "After the storage plan, if a compatible GPU is detected on the host, ProxMenux offers to launch the GPU passthrough assistant. See <link>Add GPU to a VM (Passthrough)</link> for how the assistant works — a host reboot may be required."
|
||||
},
|
||||
"autoFeatures": {
|
||||
"heading": "Automatic VM features",
|
||||
"efiTitle": "EFI disk",
|
||||
"efiBody": "When OVMF (UEFI) is selected, ProxMenux automatically creates a 4 MB EFI disk on the storage you pick, formatted to match the storage type (raw for directory-based storage).",
|
||||
"isoTitle": "ISO mounting",
|
||||
"isoBodyRich": "The installation ISO is downloaded (if needed) and attached to <code>ide2</code> as a CD-ROM, ready for first boot.",
|
||||
"guestTitle": "QEMU Guest Agent",
|
||||
"guestBody": "The guest agent channel is enabled in the VM config. You still need to install the agent inside the guest after the NAS OS is up."
|
||||
},
|
||||
"endToEnd": {
|
||||
"heading": "What the script does end-to-end",
|
||||
"itemsRich": [
|
||||
"Detects and downloads the latest stable ISO (or uses the fallback version if the upstream is unreachable).",
|
||||
"Applies the default or advanced CPU / RAM / BIOS / machine type.",
|
||||
"Opens the storage plan and attaches the selected virtual disks, imported disks and PCI devices.",
|
||||
"Creates an EFI disk if UEFI is selected.",
|
||||
"Mounts the installation ISO on <code>ide2</code>.",
|
||||
"Sets the boot order (disk first, then ISO).",
|
||||
"Enables the QEMU Guest Agent channel.",
|
||||
"Optionally runs the GPU passthrough assistant.",
|
||||
"Generates a styled HTML description attached to the VM.",
|
||||
"Starts the VM if you chose to."
|
||||
]
|
||||
},
|
||||
"perSystem": {
|
||||
"heading": "Per-system notes",
|
||||
"shellLabel": "Shell interface",
|
||||
"webLabel": "Web interface"
|
||||
},
|
||||
"systems": {
|
||||
"truenasScale": {
|
||||
"id": "truenas-scale",
|
||||
"title": "TrueNAS SCALE",
|
||||
"icon": "Database",
|
||||
"officialName": "TrueNAS SCALE",
|
||||
"officialUrl": "https://www.truenas.com/truenas-scale/",
|
||||
"description": "Debian-based TrueNAS with Docker / Kubernetes apps, Linux KVM and ZFS as the primary filesystem. The modern successor to FreeNAS for users who want ZFS plus a container ecosystem.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA or SCSI (both support discard/trim)",
|
||||
"Minimum RAM: 8 GB (16 GB+ recommended for real workloads)",
|
||||
"Minimum CPU cores: 2 (4+ recommended)",
|
||||
"UEFI (OVMF) boot recommended",
|
||||
"VirtIO network adapter for best throughput"
|
||||
],
|
||||
"shellImg": "/vm/truenas/truenas-scale-shell.png",
|
||||
"webImg": "/vm/truenas/truenas-scale-web.png",
|
||||
"shellAlt": "TrueNAS SCALE shell interface",
|
||||
"webAlt": "TrueNAS SCALE web interface"
|
||||
},
|
||||
"truenasCore": {
|
||||
"id": "truenas-core",
|
||||
"title": "TrueNAS CORE",
|
||||
"icon": "Database",
|
||||
"officialName": "TrueNAS CORE",
|
||||
"officialUrl": "https://www.truenas.com/truenas-core/",
|
||||
"description": "FreeBSD-based TrueNAS (the former FreeNAS). Mature ZFS storage with jails and plugins, but no Docker / Kubernetes. Being phased out in favour of SCALE but still widely deployed.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA",
|
||||
"Minimum RAM: 8 GB (16 GB+ recommended)",
|
||||
"Minimum CPU cores: 2 (4+ recommended)",
|
||||
"UEFI (OVMF) boot recommended",
|
||||
"VirtIO network adapter for best throughput"
|
||||
],
|
||||
"shellImg": "/vm/truenas/truenas-core-shell.png",
|
||||
"webImg": "/vm/truenas/truenas-core-web.png",
|
||||
"shellAlt": "TrueNAS CORE shell interface",
|
||||
"webAlt": "TrueNAS CORE web interface"
|
||||
},
|
||||
"openmediavault": {
|
||||
"id": "openmediavault",
|
||||
"title": "OpenMediaVault",
|
||||
"icon": "Server",
|
||||
"officialName": "openmediavault.org",
|
||||
"officialUrl": "https://www.openmediavault.org",
|
||||
"description": "Debian-based NAS with a modular plugin system. Light on resources and easy to run on modest hardware — a natural choice when you do not need ZFS.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA or VirtIO",
|
||||
"Minimum RAM: 2 GB (4 GB+ recommended)",
|
||||
"Minimum CPU cores: 1 (2+ recommended)",
|
||||
"BIOS: ProxMenux defaults to SeaBIOS for OMV (override in Advanced if needed)",
|
||||
"VirtIO network adapter for best throughput"
|
||||
],
|
||||
"shellImg": "/vm/openmediavault/openmediavault-shell.png",
|
||||
"webImg": "/vm/openmediavault/openmediavault-web.png",
|
||||
"shellAlt": "OpenMediaVault shell interface",
|
||||
"webAlt": "OpenMediaVault web interface"
|
||||
},
|
||||
"xigmanas": {
|
||||
"id": "xigmanas",
|
||||
"title": "XigmaNAS",
|
||||
"icon": "Database",
|
||||
"officialName": "xigmanas.com",
|
||||
"officialUrl": "https://www.xigmanas.com",
|
||||
"description": "FreeBSD-based NAS — the direct continuation of the original FreeNAS (0.7) codebase. Focused on ZFS and simplicity, with a lighter footprint than TrueNAS.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA or SCSI",
|
||||
"Minimum RAM: 4 GB (8 GB+ recommended for ZFS)",
|
||||
"Minimum CPU cores: 2",
|
||||
"UEFI (OVMF) boot recommended",
|
||||
"VirtIO network adapter for best throughput"
|
||||
]
|
||||
},
|
||||
"rockstor": {
|
||||
"id": "rockstor",
|
||||
"title": "Rockstor",
|
||||
"icon": "HardDrive",
|
||||
"officialName": "rockstor.com",
|
||||
"officialUrl": "https://rockstor.com",
|
||||
"description": "openSUSE Leap-based NAS built around Btrfs. Snapshots, subvolumes and the Rock-ons app framework (Docker) for media, file sharing and backup.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA or VirtIO",
|
||||
"Minimum RAM: 2 GB (4 GB+ recommended)",
|
||||
"Minimum CPU cores: 2",
|
||||
"UEFI (OVMF) boot recommended",
|
||||
"VirtIO network adapter for best throughput"
|
||||
],
|
||||
"shellImg": "/vm/rockstor/rockstor-shell.png",
|
||||
"webImg": "/vm/rockstor/rockstor-web.png",
|
||||
"shellAlt": "Rockstor shell interface",
|
||||
"webAlt": "Rockstor web interface"
|
||||
},
|
||||
"zimaos": {
|
||||
"id": "zimaos",
|
||||
"title": "ZimaOS",
|
||||
"icon": "MonitorIcon",
|
||||
"officialName": "zimaspace.com",
|
||||
"officialUrl": "https://www.zimaspace.com/zimaos",
|
||||
"description": "Lightweight NAS / home-server OS built on top of Debian, with a focus on media, Docker apps and home automation. ZimaOS uses a dedicated ProxMenux installer (vm/zimaos.sh) that downloads a pre-built image, but the VM profile follows the same flow as the other NAS systems.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA or VirtIO",
|
||||
"Default RAM: 4 GB (enough for media / self-hosted apps)",
|
||||
"Minimum CPU cores: 2",
|
||||
"UEFI (OVMF) boot",
|
||||
"VirtIO network adapter for best throughput"
|
||||
]
|
||||
}
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
"itemsRich": [
|
||||
{
|
||||
"href": "/docs/create-vm/system-nas",
|
||||
"label": "System NAS overview",
|
||||
"tail": " — quick comparison across all NAS options."
|
||||
},
|
||||
{
|
||||
"href": "/docs/create-vm/system-nas/synology",
|
||||
"label": "Synology VM",
|
||||
"tail": " — for the Synology DSM (Xpenology) flow."
|
||||
},
|
||||
{
|
||||
"href": "/docs/disk-manager/import-disk-vm",
|
||||
"label": "Import Disk to VM",
|
||||
"tail": " — recommended for NAS use cases (real disks > virtual disks)."
|
||||
},
|
||||
{
|
||||
"href": "/docs/help-info/zfs-commands",
|
||||
"label": "ZFS Management commands",
|
||||
"tail": " — if you pick TrueNAS or another ZFS-backed distribution."
|
||||
},
|
||||
{
|
||||
"href": "/docs/create-vm",
|
||||
"label": "Create VM overview",
|
||||
"tail": "."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
259
web/messages/en/docs/create-vm/system-windows.json
Normal file
259
web/messages/en/docs/create-vm/system-windows.json
Normal file
@@ -0,0 +1,259 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Create VM: System Windows | ProxMenux Documentation",
|
||||
"description": "Create and configure Windows virtual machines on Proxmox VE with ProxMenux. Includes UUP Dump ISO and local ISO paths, default / advanced configuration, the unified storage plan, optional GPU passthrough, TPM 2.0 setup and VirtIO driver install.",
|
||||
"ogTitle": "Create VM: System Windows | ProxMenux Documentation",
|
||||
"ogDescription": "Create Windows VMs on Proxmox VE with ProxMenux. UUP Dump or local ISO, unified storage plan, optional GPU passthrough, TPM 2.0 and VirtIO drivers.",
|
||||
"ogImageAlt": "ProxMenux Windows VM menu"
|
||||
},
|
||||
"header": {
|
||||
"title": "Create VM: System Windows",
|
||||
"description": "Create a Windows VM on Proxmox VE. ProxMenux handles ISO selection (UUP Dump or local), CPU / RAM / machine-type configuration, the unified storage plan, optional GPU passthrough, TPM 2.0 setup and VirtIO driver install.",
|
||||
"section": "Virtual Machines"
|
||||
},
|
||||
"intro": {
|
||||
"title": "What this script does",
|
||||
"body": "The Windows flow asks where the ISO comes from (UUP Dump or a local copy already in <code>/var/lib/vz/template/iso</code>) and then runs the shared VM wizard. It applies Windows-friendly defaults — <code>q35</code> + OVMF + TPM 2.0 — attaches the VirtIO drivers ISO to a second CD-ROM slot, and leaves you with a VM ready to boot the Windows installer."
|
||||
},
|
||||
"image": {
|
||||
"alt": "ProxMenux Windows installation options",
|
||||
"caption": "Windows installation options"
|
||||
},
|
||||
"config": {
|
||||
"heading": "Default vs Advanced configuration",
|
||||
"intro": "After the ISO is selected, ProxMenux asks whether to use the default VM profile or open the advanced wizard. The default profile is tuned for modern Windows desktop and server editions.",
|
||||
"defaultHeading": "Default configuration",
|
||||
"headerParam": "Parameter",
|
||||
"headerValue": "Default value",
|
||||
"defaultRows": [
|
||||
{
|
||||
"param": "Machine type",
|
||||
"valueRich": "<code>q35</code>"
|
||||
},
|
||||
{
|
||||
"param": "BIOS",
|
||||
"value": "OVMF (UEFI)"
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"value": "Host"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
"value": "4"
|
||||
},
|
||||
{
|
||||
"param": "RAM",
|
||||
"value": "8192 MB"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"valueRich": "<code>vmbr0</code>"
|
||||
},
|
||||
{
|
||||
"param": "MAC address",
|
||||
"value": "Auto-generated"
|
||||
},
|
||||
{
|
||||
"param": "TPM",
|
||||
"value": "Enabled (v2.0)"
|
||||
},
|
||||
{
|
||||
"param": "Start on completion",
|
||||
"value": "No"
|
||||
}
|
||||
],
|
||||
"advancedHeading": "Advanced configuration",
|
||||
"advancedIntro": "The advanced wizard exposes every knob individually:",
|
||||
"headerOptions": "Options",
|
||||
"advancedRows": [
|
||||
{
|
||||
"param": "Machine type",
|
||||
"optionsRich": "<code>q35</code> or <code>i440fx</code>"
|
||||
},
|
||||
{
|
||||
"param": "BIOS",
|
||||
"options": "OVMF (UEFI) or SeaBIOS (Legacy)"
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"options": "Host or KVM64"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
"options": "Number of CPU cores"
|
||||
},
|
||||
{
|
||||
"param": "RAM",
|
||||
"options": "Memory allocated to the VM"
|
||||
},
|
||||
{
|
||||
"param": "Bridge",
|
||||
"options": "Network bridge"
|
||||
},
|
||||
{
|
||||
"param": "MAC address",
|
||||
"options": "Custom MAC"
|
||||
},
|
||||
{
|
||||
"param": "VLAN",
|
||||
"options": "VLAN tag (optional)"
|
||||
},
|
||||
{
|
||||
"param": "MTU",
|
||||
"options": "MTU size"
|
||||
},
|
||||
{
|
||||
"param": "TPM",
|
||||
"options": "Enable or disable TPM 2.0"
|
||||
}
|
||||
],
|
||||
"tpmWarnTitle": "Windows 11 and Windows Server 2022 need TPM",
|
||||
"tpmWarnBody": "Windows 11 and Windows Server 2022 refuse to install without a TPM 2.0 device attached to the VM. ProxMenux adds it by default; only disable it in Advanced if you know the target edition does not require it."
|
||||
},
|
||||
"storagePlan": {
|
||||
"heading": "Storage plan",
|
||||
"body": "After CPU / RAM, ProxMenux opens the <strong>Storage Plan</strong> menu, where you can combine virtual disks, imported disks and PCI passthrough devices in the same VM, adding items one at a time and finishing when you are done.",
|
||||
"virtualDiskTitle": "a. Add virtual disk",
|
||||
"virtualDiskItems": [
|
||||
"Lists the Proxmox storage volumes available on the host.",
|
||||
"You pick the target storage and the size in GB.",
|
||||
"The disk is attached to the VM as SATA (<code>sata0</code>, <code>sata1</code>, … up to 6)."
|
||||
],
|
||||
"importDiskTitle": "b. Add import disk",
|
||||
"importDiskItems": [
|
||||
"Detects physical disks that are safe to import (system and protected disks are hidden).",
|
||||
"You select one or more disks via a checklist.",
|
||||
"Imported disks are attached as SATA via <code>qm set</code>."
|
||||
],
|
||||
"pciTitle": "c. Add Controller or NVMe (PCI passthrough)",
|
||||
"pciItems": [
|
||||
"Detects SATA/SAS HBAs and NVMe devices on the host and lets you pass an <em>entire controller</em> into the VM. IOMMU must be enabled; the script offers to enable it and reboots if required.",
|
||||
"A confirmation step warns about controller-wide risk (the whole card, including every disk on it, leaves the host).",
|
||||
"The selected PCI devices are attached via <code>qm set hostpciN: …</code>."
|
||||
],
|
||||
"resetTitle": "Reset and finish",
|
||||
"resetBody": "The menu also offers <strong>r</strong> (reset the current selection and start over) and <strong>d</strong> (finish and continue). You cannot finish with an empty plan."
|
||||
},
|
||||
"gpu": {
|
||||
"heading": "Optional GPU passthrough",
|
||||
"body": "After the storage plan, if a compatible GPU is detected on the host ProxMenux offers to launch the GPU passthrough assistant. See <gpuLink>Add GPU to a VM (Passthrough)</gpuLink> for how the assistant works — a host reboot may be required."
|
||||
},
|
||||
"autoFeatures": {
|
||||
"heading": "Automatic VM features",
|
||||
"efiTitle": "EFI disk",
|
||||
"efiBody": "When OVMF (UEFI) is selected, ProxMenux creates a 4 MB EFI system disk on the storage you pick and attaches it to the VM so the UEFI firmware has a place to store its variables.",
|
||||
"tpmTitle": "TPM 2.0",
|
||||
"tpmBody": "A virtual TPM 2.0 device is added automatically so Windows 11 / Server 2022 installers pass the hardware compatibility check.",
|
||||
"isoTitle": "ISO mounting",
|
||||
"isoBody": "The installation ISO is attached to <code>ide2</code>. The VirtIO drivers ISO is downloaded (if needed) and attached to <code>ide3</code>, ready for the <em>Load driver</em> step.",
|
||||
"guestTitle": "QEMU Guest Agent",
|
||||
"guestBody": "The guest agent channel is enabled in the VM config. The agent itself is installed inside Windows by running <code>virtio-win-guest-tools.exe</code> after setup."
|
||||
},
|
||||
"installOptions": {
|
||||
"heading": "Windows installation options",
|
||||
"intro": "ProxMenux offers two methods to obtain the Windows installation media:",
|
||||
"uupTitle": "UUP Dump ISO Creator",
|
||||
"uupLogoAlt": "UUP Dump logo",
|
||||
"uupBody": "The <strong>UUP Dump ISO Creator</strong> script is a ProxMenux utility that builds a Windows ISO on the fly from Microsoft's Windows Update servers. It pulls clean, official installation files (including Insider Preview builds).",
|
||||
"uupItems": [
|
||||
"Access to the latest Windows builds.",
|
||||
"Supports Insider Preview versions.",
|
||||
"Clean, official Microsoft installation files.",
|
||||
"Automatic ISO creation and mounting in the VM.",
|
||||
"Supports Home, Pro and Enterprise editions."
|
||||
],
|
||||
"uupLearnMore": "Learn more about UUP Dump ISO Creator",
|
||||
"localTitle": "Install with local ISO",
|
||||
"localBody": "Uses a Windows ISO you have already uploaded to the host's local storage (<code>/var/lib/vz/template/iso</code>). The script lists every non-VirtIO ISO it finds and lets you pick one.",
|
||||
"localImageAlt": "Local ISO selection menu",
|
||||
"localImageCaption": "Local ISO selection menu"
|
||||
},
|
||||
"endToEnd": {
|
||||
"heading": "What the script does end-to-end",
|
||||
"items": [
|
||||
"Obtains the Windows ISO (UUP Dump build or local copy).",
|
||||
"Applies the default or advanced CPU / RAM / BIOS / machine-type configuration.",
|
||||
"Opens the storage plan and attaches the selected virtual disks, imported disks and PCI devices.",
|
||||
"Creates the EFI disk (UEFI installs) and attaches the TPM 2.0 device.",
|
||||
"Mounts the Windows ISO on <code>ide2</code>.",
|
||||
"Downloads and mounts the VirtIO drivers ISO on <code>ide3</code>.",
|
||||
"Sets the boot order (disk first, then ISO).",
|
||||
"Enables the QEMU Guest Agent channel.",
|
||||
"Optionally runs the GPU passthrough assistant.",
|
||||
"Generates a styled HTML description attached to the VM.",
|
||||
"Starts the VM if you chose to."
|
||||
]
|
||||
},
|
||||
"virtio": {
|
||||
"heading": "VirtIO drivers during installation",
|
||||
"body": "If you leave storage and networking at defaults (SATA + e1000), Windows will install without extra steps. However, the Proxmox storage plan always attaches virtual disks as SATA, which works out of the box. Where VirtIO becomes relevant is if, during the Advanced wizard, you pick VirtIO or SCSI for disks or VirtIO for the NIC — in that case Windows will not see those devices until the matching driver is loaded from the VirtIO ISO mounted at <code>ide3</code>.",
|
||||
"warnTitle": "Without the VirtIO network driver there is no internet during install",
|
||||
"warnBody": "If you picked VirtIO (<code>virtio</code>) as the network interface and do not load the driver during setup, Windows will not have internet access. That can block activation and Windows Update steps during first boot.",
|
||||
"stepLabel": "Step",
|
||||
"steps": [
|
||||
{
|
||||
"title": "Access the \"Where do you want to install Windows?\" screen",
|
||||
"body": "During Windows setup, if no disks are shown, the storage driver for your selected interface (SCSI or VirtIO) is not loaded yet. Load it manually from the mounted VirtIO ISO.",
|
||||
"img": "/vm/windows/virtio-step-1.png",
|
||||
"caption": "Windows setup with no disks shown"
|
||||
},
|
||||
{
|
||||
"title": "Click \"Load driver\"",
|
||||
"bodyRich": "Click <strong>Load driver</strong> to browse the mounted VirtIO ISO and pick the storage driver that matches the interface you chose.",
|
||||
"img": "/vm/windows/virtio-step-2.png",
|
||||
"caption": "Click Load driver to browse the VirtIO ISO"
|
||||
},
|
||||
{
|
||||
"title": "Browse to the correct driver folder",
|
||||
"bodyRich": "On the VirtIO ISO navigate to the folder that matches the interface and Windows version — for example <code>viostor</code> for VirtIO SCSI, with subfolders per Windows edition (10 / 11 / Server).",
|
||||
"img": "/vm/windows/virtio-step-3.png",
|
||||
"caption": "Browse to the appropriate driver folder"
|
||||
},
|
||||
{
|
||||
"title": "Select the driver",
|
||||
"bodyRich": "Windows lists the available drivers. Pick the one that matches your setup (typically <strong>Red Hat VirtIO SCSI controller</strong>) and click <strong>Next</strong>.",
|
||||
"img": "/vm/windows/virtio-step-4.png",
|
||||
"caption": "Select the VirtIO driver that matches your disk interface"
|
||||
},
|
||||
{
|
||||
"title": "(Optional) Install the network driver",
|
||||
"bodyRich": "If you also picked VirtIO as the network interface, load the network driver from the <code>NetKVM</code> folder of the same ISO, selecting the subfolder for your Windows version. Without this step Windows installs without internet access.",
|
||||
"img": "/vm/windows/virtio-step-5.png",
|
||||
"caption": "Load the VirtIO network driver to enable internet during install"
|
||||
}
|
||||
],
|
||||
"tipTitle": "Post-install: run virtio-win-guest-tools.exe",
|
||||
"tipBody": "After Windows is installed, open the VirtIO ISO from File Explorer and run <code>virtio-win-guest-tools.exe</code>. It installs the remaining drivers (network, display, input, ballooning, QEMU Guest Agent) in one shot."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
"items": [
|
||||
{
|
||||
"href": "/docs/utils/UUp-Dump-ISO-Creator",
|
||||
"label": "UUP Dump ISO Creator",
|
||||
"tail": " — generate up-to-date Windows installation ISOs on the Proxmox host."
|
||||
},
|
||||
{
|
||||
"href": "/docs/disk-manager/import-disk-image-vm",
|
||||
"label": "Import Disk Image to VM",
|
||||
"tail": " — attach an existing Windows .vhdx / .vmdk to a fresh VM."
|
||||
},
|
||||
{
|
||||
"href": "/docs/hardware/gpu-vm-passthrough",
|
||||
"label": "Add GPU to VM (Passthrough)",
|
||||
"tail": " — for Windows VMs with hardware-accelerated GPU."
|
||||
},
|
||||
{
|
||||
"href": "/docs/help-info/vm-ct-commands",
|
||||
"label": "VM and CT Management commands",
|
||||
"tail": " — qm CLI reference."
|
||||
},
|
||||
{
|
||||
"href": "/docs/create-vm",
|
||||
"label": "Create VM overview",
|
||||
"tail": "."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user