mirror of
https://github.com/MacRimi/ProxMenux.git
synced 2026-11-02 10:52:22 +00:00
docs: review VM creation documentation in all seven translations
This commit is contained in:
Jonatan
@@ -13,7 +13,7 @@
|
||||
},
|
||||
"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."
|
||||
"body": "For the generic ISO flow, the NAS selector tries to detect the latest stable release from the project’s mirror, uses a fallback version if needed, downloads the ISO and opens the shared VM configurator for CPU, RAM, disks and networking. Synology DSM and ZimaOS use dedicated installer flows."
|
||||
},
|
||||
"image": {
|
||||
"alt": "ProxMenux System NAS selector",
|
||||
@@ -43,7 +43,7 @@
|
||||
},
|
||||
{
|
||||
"name": "TrueNAS SCALE",
|
||||
"tagline": "Debian-based TrueNAS with Docker / Kubernetes apps and ZFS as primary filesystem.",
|
||||
"tagline": "Debian-based TrueNAS with Docker apps in current releases and ZFS as the primary filesystem. Kubernetes was used by older SCALE releases.",
|
||||
"icon": "Database",
|
||||
"base": "Debian Linux",
|
||||
"fileSystem": "ZFS",
|
||||
@@ -52,7 +52,7 @@
|
||||
},
|
||||
{
|
||||
"name": "TrueNAS CORE",
|
||||
"tagline": "FreeBSD-based TrueNAS. Enterprise-grade ZFS storage with jails and plugins.",
|
||||
"tagline": "FreeBSD-based TrueNAS focused on ZFS storage. Jails and plugins in CORE 13.3 are obsolete and unsupported.",
|
||||
"icon": "Database",
|
||||
"base": "FreeBSD",
|
||||
"fileSystem": "ZFS",
|
||||
@@ -90,7 +90,7 @@
|
||||
"name": "ZimaOS",
|
||||
"tagline": "Lightweight NAS OS focused on media, Docker apps and home automation. Uses its own installer.",
|
||||
"icon": "MonitorIcon",
|
||||
"base": "Debian / CasaOS",
|
||||
"base": "Buildroot (evolved from CasaOS)",
|
||||
"fileSystem": "ext4",
|
||||
"href": "/docs/create-vm/system-nas/system-nas-others#zimaos",
|
||||
"flow": "dedicated"
|
||||
@@ -112,7 +112,7 @@
|
||||
},
|
||||
"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."
|
||||
"bodyRich": "For TrueNAS, allocate at least <strong>8 GB RAM</strong> for basic operation and more for demanding workloads. ZFS uses RAM for its ARC cache, but there is no universal 8 GB performance cliff for every ZFS-based NAS. Check the chosen distribution’s requirements and size memory for its disks, services and apps; lighter OMV or Rockstor setups can need less."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
{
|
||||
"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.",
|
||||
"description": "Create a Synology DSM virtual machine on Proxmox VE. ProxMenux downloads your chosen loader (Arc, RR, Alpine RedPill M-shell or a custom image), imports it as the VM boot disk and configures 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.",
|
||||
"description": "Create a Synology DSM virtual machine on Proxmox VE. ProxMenux downloads your chosen loader (Arc, RR, Alpine RedPill M-shell or a custom image), imports it as the VM boot disk and configures CPU, RAM and storage through the default or advanced wizard.",
|
||||
"section": "Virtual Machines · NAS"
|
||||
},
|
||||
"loaderLabels": {
|
||||
@@ -32,7 +32,7 @@
|
||||
"url": "https://github.com/RROrg/rr"
|
||||
},
|
||||
{
|
||||
"name": "TinyCore RedPill M-shell",
|
||||
"name": "Alpine RedPill M-shell (TinyCore project)",
|
||||
"url": "https://github.com/PeterSuh-Q3/tinycore-redpill"
|
||||
}
|
||||
],
|
||||
@@ -127,7 +127,7 @@
|
||||
"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)."
|
||||
"The disk is attached as SATA (<code>sata0</code>, <code>sata1</code>, …). Virtual and physical data disks share the six SATA slots numbered 0–5."
|
||||
],
|
||||
"importHeading": "b. Add import disk",
|
||||
"importItemsRich": [
|
||||
@@ -139,7 +139,7 @@
|
||||
"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>."
|
||||
"The selected PCI devices are attached with commands such as <code>qm set VMID --hostpci0 PCI_ADDRESS,pcie=1</code>. Replace VMID and PCI_ADDRESS with the VM ID and PCI address, and use an unused hostpci index for each device."
|
||||
],
|
||||
"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."
|
||||
@@ -150,7 +150,7 @@
|
||||
},
|
||||
"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.",
|
||||
"intro1Rich": "<strong>Arc</strong>, <strong>RR</strong> and <strong>Alpine RedPill 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",
|
||||
@@ -161,15 +161,15 @@
|
||||
"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."
|
||||
"<code>qm importdisk</code> imports the loader image to Proxmox storage. The script then attaches it to the VM as an <strong>IDE</strong> disk on ide0 for compatibility.",
|
||||
"<code>qm set VMID --sata0 DISK_REFERENCE</code> attaches a planned data disk. Replace VMID and DISK_REFERENCE with the VM ID and disk reference; use a free SATA index from 0–5. The network adapter is configured by qm create.",
|
||||
"<code>qm set VMID --hostpci0 PCI_ADDRESS,pcie=1</code> attaches a selected PCI controller or NVMe device. Replace VMID and PCI_ADDRESS with the VM ID and PCI address, and use a free hostpci index for each device.",
|
||||
"<code>qm set VMID --boot order=ide0</code> configures the loader as the boot device. Replace VMID with the VM ID."
|
||||
]
|
||||
},
|
||||
"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.",
|
||||
"intro": "The six common steps are: start the VM, choose a model, choose a DSM version, choose add-ons, build and boot. Menus and options vary by release. The M-shell screenshots below show an earlier TinyCore interface; the current script downloads Alpine RedPill M-shell, so follow its current prompts.",
|
||||
"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)."
|
||||
},
|
||||
|
||||
@@ -69,7 +69,7 @@
|
||||
},
|
||||
{
|
||||
"param": "CPU type",
|
||||
"optionsRich": "Host or KVM64"
|
||||
"optionsRich": "Host, KVM64 and other listed CPU models"
|
||||
},
|
||||
{
|
||||
"param": "Cores",
|
||||
@@ -97,7 +97,7 @@
|
||||
}
|
||||
],
|
||||
"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."
|
||||
"zfsCalloutBody": "TrueNAS SCALE / CORE and XigmaNAS use ZFS, whose ARC cache benefits from RAM. TrueNAS needs at least 8 GB for basic use; 16 GB or more can help with heavier services and apps. Size the VM for the chosen distribution and workload rather than treating 8 GB as a universal ZFS minimum. Lighter OMV, Rockstor or ZimaOS setups can need less."
|
||||
},
|
||||
"storagePlan": {
|
||||
"heading": "Storage plan",
|
||||
@@ -106,19 +106,19 @@
|
||||
"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)."
|
||||
"The disk uses the selected bus: SCSI (default), SATA, VirtIO or IDE. SATA slots are <code>sata0</code>, <code>sata1</code>, …, with six slots numbered 0–5."
|
||||
],
|
||||
"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>."
|
||||
"Imported disks use the selected bus and are attached 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>."
|
||||
"The selected PCI devices are attached with commands such as <code>qm set VMID --hostpci0 PCI_ADDRESS,pcie=1</code>. Replace VMID and PCI_ADDRESS with the VM ID and PCI address, and use an unused hostpci index for each device."
|
||||
],
|
||||
"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."
|
||||
@@ -163,7 +163,7 @@
|
||||
"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.",
|
||||
"description": "Debian-based TrueNAS with Docker apps in current releases, Linux KVM and ZFS as the primary filesystem. Older SCALE releases used Kubernetes. It combines ZFS storage with a container ecosystem.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA or SCSI (both support discard/trim)",
|
||||
"Minimum RAM: 8 GB (16 GB+ recommended for real workloads)",
|
||||
@@ -182,7 +182,7 @@
|
||||
"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.",
|
||||
"description": "FreeBSD-based TrueNAS, formerly FreeNAS, focused on ZFS storage. CORE 13.3 jails, plugins and virtualization features are obsolete and unsupported; current development focuses on the Linux-based editions.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA",
|
||||
"Minimum RAM: 8 GB (16 GB+ recommended)",
|
||||
@@ -254,7 +254,7 @@
|
||||
"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.",
|
||||
"description": "Lightweight NAS / home-server OS built with Buildroot, evolved from CasaOS, 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, while offering CPU, RAM and storage configuration.",
|
||||
"specs": [
|
||||
"Recommended interface: SATA or VirtIO",
|
||||
"Default RAM: 4 GB (enough for media / self-hosted apps)",
|
||||
|
||||
Reference in New Issue
Block a user