diff --git a/web/app/docs/create-vm/page.tsx b/web/app/docs/create-vm/page.tsx new file mode 100644 index 0000000..9c16901 --- /dev/null +++ b/web/app/docs/create-vm/page.tsx @@ -0,0 +1,174 @@ +import type React from "react" +import type { Metadata } from "next" +import Link from "next/link" +import Image from "next/image" +import { Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle } from "@/components/ui/card" +import { ArrowRight, Server, ComputerIcon as Windows, LaptopIcon as Linux, HardDrive, Monitor } from "lucide-react" + +export const metadata: Metadata = { + title: "ProxMenux Documentation: Virtual Machines", + description: + "Comprehensive guide for creating and configuring virtual machines on Proxmox VE using ProxMenux, with dedicated sections for NAS, Windows, and Linux systems.", + openGraph: { + title: "ProxMenux Documentation: Virtual Machines", + description: + "Comprehensive guide for creating and configuring virtual machines on Proxmox VE using ProxMenux, with dedicated sections for NAS, Windows, and Linux systems.", + type: "article", + url: "https://macrimi.github.io/ProxMenux/docs/virtual-machines", + images: [ + { + url: "https://macrimi.github.io/ProxMenux/vm/vm-creation-menu.png", + width: 1200, + height: 630, + alt: "ProxMenux Virtual Machines Menu", + }, + ], + }, + twitter: { + card: "summary_large_image", + title: "ProxMenux Documentation: Virtual Machines", + description: + "Comprehensive guide for creating and configuring virtual machines on Proxmox VE using ProxMenux, with dedicated sections for NAS, Windows, and Linux systems.", + images: ["https://macrimi.github.io/ProxMenux/vm/vm-creation-menu.png"], + }, +} + +interface ImageWithCaptionProps { + src: string + alt: string + caption: string + +} + +function ImageWithCaption({ src, alt, caption }: ImageWithCaptionProps) { + return ( +
+
+ {alt} +
+ {caption} +
+ ) +} + +export default function VirtualMachinesPage() { + return ( +
+
+
+ +

Virtual Machines Menu

+
+ +
+

+ ProxMenux provides an automated system for creating and configuring virtual machines on Proxmox VE through + an interactive menu interface. Select one of the categories below to explore the available VM creation + options. +

+ +

+ Each category contains specialized scripts and configurations designed to simplify the process of creating + virtual machines for different operating systems and use cases. This eliminates the need to remember complex + command syntax or manually configure VMs when deploying new systems. +

+
+
+ + + +
+ } + href="/docs/create-vm/system-nas" + /> + + } + href="/docs/create-vm/system-windows" + /> + + } + href="/docs/create-vm/system-linux" + /> + + } + href="/docs/create-vm/other-linux" + /> + + } + href="https://osx-proxmox.com" + externalLink + /> +
+
+ ) +} + +interface VMCardProps { + title: string + description: string + icon: React.ReactNode + href: string + externalLink?: boolean +} + +function VMCard({ title, description, icon, href, externalLink = false }: VMCardProps) { + return ( + + +
+ {icon} + {title} +
+ + + {description} + + + {externalLink ? ( + + View details + + ) : ( + + View details + + )} + + + ) +} diff --git a/web/app/docs/create-vm/system-nas/page.tsx b/web/app/docs/create-vm/system-nas/page.tsx new file mode 100644 index 0000000..08a69e0 --- /dev/null +++ b/web/app/docs/create-vm/system-nas/page.tsx @@ -0,0 +1,318 @@ +import type React from "react" +import type { Metadata } from "next" +import Link from "next/link" +import Image from "next/image" +import { HardDrive, Info, Database, Server, MonitorIcon, Star, Cpu, Github } from "lucide-react" +import { Badge } from "@/components/ui/badge" + +export const metadata: Metadata = { + title: "ProxMenux Documentation: System NAS Virtual Machines", + description: + "Guide for creating and configuring NAS virtual machines on Proxmox VE using ProxMenux, including Synology DSM, TrueNAS, and other storage systems.", + openGraph: { + title: "ProxMenux Documentation: System NAS Virtual Machines", + description: + "Guide for creating and configuring NAS virtual machines on Proxmox VE using ProxMenux, including Synology DSM, TrueNAS, and other storage systems.", + type: "article", + url: "https://macrimi.github.io/ProxMenux/docs/virtual-machines/system-nas", + images: [ + { + url: "https://macrimi.github.io/ProxMenux/vm/system-nas-menu.png", + width: 1200, + height: 630, + alt: "ProxMenux System NAS Menu", + }, + ], + }, + twitter: { + card: "summary_large_image", + title: "ProxMenux Documentation: System NAS Virtual Machines", + description: + "Guide for creating and configuring NAS virtual machines on Proxmox VE using ProxMenux, including Synology DSM, TrueNAS, and other storage systems.", + images: ["https://macrimi.github.io/ProxMenux/vm/system-nas-menu.png"], + }, +} + +interface ImageWithCaptionProps { + src: string + alt: string + caption: string +} + +function ImageWithCaption({ src, alt, caption }: ImageWithCaptionProps) { + return ( +
+
+ {alt} +
+ {caption} +
+ ) +} + +interface NASSystemProps { + name: string + description: string + icon: React.ReactNode + features: string[] + technicalDetails: string[] + href: string + isExternal?: boolean + externalUrl?: string +} + +function NASSystemItem({ + name, + description, + icon, + features, + technicalDetails, + href, + isExternal, + externalUrl, +}: NASSystemProps) { + return ( +
+
+
+ {isExternal && externalUrl ? ( + + {icon} +

{name}

+ + ) : ( + + {icon} +

{name}

+ + )} + + {isExternal && ( +
+ + + + External Script + + + {/* Removed the external link icon since the title now links to the external URL */} +
+ )} +
+
+ +
+
+

{description}

+ +
+
+

+ + Key Features: +

+
    + {features.map((feature, index) => ( +
  • {feature}
    • + ))} +
+
+ +
+

+ + Technical Details: +

+
    + {technicalDetails.map((detail, index) => ( +
  • {detail}
    • + ))} +
+
+
+
+
+
+ ) +} + +export default function SystemNASPage() { + return ( +
+
+
+ +

System NAS Virtual Machines

+
+ +
+

+ ProxMenux provides automated scripts that create and configure virtual machines for various NAS systems on + Proxmox VE. These scripts simplify the process by handling the necessary configurations and optimizations + for each NAS platform. +

+
+
+ + + +
+
+ +

Available NAS Systems

+
+

+ Select one of the NAS systems below to view detailed documentation on installation and configuration. +

+
+ +
+ } + features={[ + "User-friendly web interface", + "Extensive app ecosystem", + "File sharing and synchronization", + "Media streaming capabilities", + ]} + technicalDetails={[ + "Base OS: Linux (Custom)", + "File Systems: Btrfs, ext4", + "Virtualization: Yes (Docker)", + "Hardware Requirements: Moderate", + ]} + href="/docs/virtual-machines/system-nas/synology" + /> + + } + features={[ + "Linux-based (Debian)", + "Docker container support", + "Kubernetes integration", + "Scale-out clustering capabilities", + ]} + technicalDetails={[ + "Base OS: Debian Linux", + "File System: ZFS", + "Virtualization: Yes (KVM)", + "Hardware Requirements: High", + ]} + href="/docs/create-vm/system-nas/system-nas-others" + /> + + } + features={["FreeBSD-based", "ZFS file system", "Snapshots and replication", "Encryption"]} + technicalDetails={[ + "Base OS: FreeBSD", + "File System: ZFS", + "Virtualization: Yes (Jails)", + "Hardware Requirements: Moderate to High", + ]} + href="/docs/create-vm/system-nas/system-nas-others" + /> + + } + features={[ + "Modular plugin architecture", + "Multiple filesystem support", + "Docker support via plugins", + "Low resource requirements", + ]} + technicalDetails={[ + "Base OS: Debian Linux", + "File Systems: ext4, XFS, Btrfs", + "Virtualization: Yes (via plugins)", + "Hardware Requirements: Low", + ]} + href="/docs/create-vm/system-nas/system-nas-others" + /> + + } + features={[ + "BTRFS file system", + "Web-based UI", + "Docker-based app framework (Rock-ons)", + "Snapshots and replication", + ]} + technicalDetails={[ + "Base OS: openSUSE based", + "File System: Btrfs", + "Virtualization: Yes (Docker)", + "Hardware Requirements: Moderate", + ]} + href="/docs/create-vm/system-nas/system-nas-others" + /> + + } + features={[ + "Low resource footprint", + "Docker support", + "Media streaming optimization", + "Home automation integration", + ]} + technicalDetails={[ + "Base OS: ROGGER proxmox-zimaos", + "File Systems: ext4, XFS", + "Virtualization: Yes (Docker)", + "Hardware Requirements: Low", + ]} + + isExternal={true} + externalUrl="https://www.zimaspace.com/docs/zimaos/" + /> +
+ +
+

About NAS Virtual Machines

+
+

+ Network Attached Storage (NAS) systems provide file-level data storage services to other devices on the + network. Running NAS software in a virtual machine on Proxmox VE allows you to leverage the reliability and + management features of Proxmox while providing flexible storage solutions. +

+ +

+ ProxMenux simplifies the creation of NAS virtual machines by automating the configuration process, including + network settings, storage allocation, and system optimization for each specific NAS platform. +

+
+
+
+ ) +} diff --git a/web/app/docs/create-vm/system-nas/system-nas-others/page.tsx b/web/app/docs/create-vm/system-nas/system-nas-others/page.tsx new file mode 100644 index 0000000..a98004e --- /dev/null +++ b/web/app/docs/create-vm/system-nas/system-nas-others/page.tsx @@ -0,0 +1,648 @@ +import type { Metadata } from "next" +import Link from "next/link" +import Image from "next/image" +import { ArrowLeft, HardDrive, Settings, Zap, Sliders, Server, Database, ExternalLink } from "lucide-react" + +export const metadata: Metadata = { + title: "ProxMenux Documentation: Other NAS Systems VM Creation", + description: + "Guide for creating and configuring virtual machines for TrueNAS SCALE, TrueNAS CORE, OpenMediaVault, and Rockstor on Proxmox VE using ProxMenux.", + openGraph: { + title: "ProxMenux Documentation: Other NAS Systems VM Creation", + description: + "Guide for creating and configuring virtual machines for TrueNAS SCALE, TrueNAS CORE, OpenMediaVault, and Rockstor on Proxmox VE using ProxMenux.", + type: "article", + url: "https://macrimi.github.io/ProxMenux/docs/virtual-machines/system-nas/others", + images: [ + { + url: "https://macrimi.github.io/ProxMenux/vm/other-nas-systems.png", + width: 1200, + height: 630, + alt: "ProxMenux Other NAS Systems", + }, + ], + }, + twitter: { + card: "summary_large_image", + title: "ProxMenux Documentation: Other NAS Systems VM Creation", + description: + "Guide for creating and configuring virtual machines for TrueNAS SCALE, TrueNAS CORE, OpenMediaVault, and Rockstor on Proxmox VE using ProxMenux.", + images: ["https://macrimi.github.io/ProxMenux/vm/other-nas-systems.png"], + }, +} + +interface ImageWithCaptionProps { + src: string + alt: string + caption: string +} + +function ImageWithCaption({ src, alt, caption }: ImageWithCaptionProps) { + return ( +
+
+ {alt} +
+ {caption} +
+ ) +} + +export default function OtherNASSystemsPage() { + return ( +
+
+ +
+ +

NAS Systems VM Creation

+
+ +
+

+ ProxMenux provides automated scripts that create and configure virtual machines for various NAS systems on + Proxmox VE. This documentation covers the VM creation process for TrueNAS SCALE, TrueNAS CORE, + OpenMediaVault, and Rockstor. +

+
+
+ + +
+

Script Overview

+

+ The VM creation script for NAS systems automates the process of setting up virtual machines optimized for + running various Network Attached Storage solutions. The script handles all aspects of VM configuration, + including hardware allocation, disk setup, and boot options. +

+ +

The script simplifies the VM creation process by offering the following options:

+ + +
+

+ + Default and Advanced Configuration +

+

The script offers two configuration modes:

+ +

+ + Default Configuration +

+

+ If you select default configuration, the script will automatically apply the following values: +

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDefault Value
Machine Typeq35
BIOS TypeOVMF (UEFI)
CPU TypeHost
Core Count2
RAM Size8192 MB
Bridgevmbr0
MAC AddressAutomatically generated
Start VM on CompletionNo
+
+

+ If you want to customize the configuration, select the Advanced Settings option in the menu. +

+ +

+ + Advanced Configuration +

+

+ If you select advanced configuration, the script will allow you to customize each parameter: +

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterOptions
Machine Typeq35 or i440fx
BIOS TypeOVMF (UEFI) or SeaBIOS (Legacy)
CPU TypeHost or KVM64
Core CountNumber of CPU cores
RAM SizeAmount of memory allocated to the VM
BridgeNetwork bridge for connection
MAC AddressCustom MAC address
VLANVLAN tag (if used)
MTUMaximum Transmission Unit size
+
+
+ +
+

+ + Disk Interface Selection +

+

+ Unlike the Synology-specific script, this script allows you to choose the disk interface type for both + virtual and physical disks: +

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Interface TypeDescriptionBest For
SCSI + Modern interface with good performance and features + + Recommended for Linux and Windows (includes discard/trim support) +
SATAStandard interface with high compatibility + Good general-purpose choice (includes discard/trim support) +
VirtIO + Paravirtualized interface with highest performance + + Advanced users seeking maximum performance (includes discard/trim support) +
IDELegacy interface with maximum compatibilityLegacy systems only (no discard/trim support)
+
+
+ +
+

+ + Disk Selection +

+

+ Once the machine is configured, the script allows you to choose between two types of disks: +

+ +

Virtual Disk

+
    +
  • 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 using the selected interface type (SCSI, SATA, + VirtIO, or IDE) +
    • +
  • + Multiple disks can be added and will be assigned sequential device numbers (e.g., scsi0, scsi1, etc.) +
    • +
+ +

Physical Disk Passthrough

+
    +
  • 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 using the selected interface type (SCSI, + SATA, VirtIO, or IDE) +
    • +
  • + Multiple disks can be added and will be assigned sequential device numbers (e.g., scsi0, scsi1, etc.) +
    • +
+
+ +
+

+ + Additional Features +

+ +

EFI Disk Configuration

+

When UEFI BIOS (OVMF) is selected, the script automatically configures an EFI disk:

+
    +
  • The script prompts for storage location for the EFI disk
    • +
  • A 4MB EFI disk is created and configured
    • +
  • + The EFI disk is properly formatted based on the storage type (raw format for directory-based storage) +
    • +
+ +

ISO Mounting

+

The script handles ISO mounting for installation:

+
    +
  • The installation ISO is automatically mounted to the ide2 device
    • +
  • For Windows VMs, VirtIO driver ISO can be automatically downloaded and mounted to ide3
    • +
+ +

QEMU Guest Agent

+

The script automatically configures QEMU Guest Agent support:

+
    +
  • Enables the QEMU Guest Agent in the VM configuration
    • +
  • Sets up the necessary communication channel
    • +
  • Provides instructions for installing the guest agent inside the VM after installation
    • +
+
+ +
+

NAS-Specific Installation Notes

+ +
+
+
+ +

TrueNAS SCALE

+
+
    +
  • + Recommended interface: SATA or SCSI +
    • +
  • + Minimum RAM: 8GB (16GB+ recommended) +
    • +
  • + Minimum CPU cores: 2 (4+ recommended) +
    • +
  • UEFI boot is recommended
    • +
  • VirtIO network adapter provides best performance
    • +
  • + After installation, install the QEMU Guest Agent: + 
    +                    apt update && apt install qemu-guest-agent -y
+
    +
    • +
+
+ +
+
+ +

TrueNAS CORE

+
+
    +
  • + Recommended interface: SATA +
    • +
  • + Minimum RAM: 8GB (16GB+ recommended) +
    • +
  • + Minimum CPU cores: 2 (4+ recommended) +
    • +
  • UEFI boot is recommended
    • +
  • VirtIO network adapter provides best performance
    • +
  • + After installation, install the QEMU Guest Agent: + 
    +                    pkg install -y qemu-guest-agent && sysrc qemu_guest_agent_enable=YES && service qemu-guest-agent
+                    start
+
    +
    • +
+
+ +
+
+ +

OpenMediaVault

+
+
    +
  • + Recommended interface: SATA or VirtIO +
    • +
  • + Minimum RAM: 2GB (4GB+ recommended) +
    • +
  • + Minimum CPU cores: 1 (2+ recommended) +
    • +
  • Both UEFI and Legacy BIOS are supported
    • +
  • VirtIO network adapter provides best performance
    • +
  • + After installation, install the QEMU Guest Agent: + 
    +                    apt update && apt install qemu-guest-agent -y
+
    +
    • +
+
+ +
+
+ +

Rockstor

+
+
    +
  • + Recommended interface: SATA or VirtIO +
    • +
  • + Minimum RAM: 2GB (4GB+ recommended) +
    • +
  • + Minimum CPU cores: 2 +
    • +
  • UEFI boot is recommended
    • +
  • VirtIO network adapter provides best performance
    • +
  • + After installation, install the QEMU Guest Agent: + 
    +                    dnf install -y qemu-guest-agent && systemctl enable --now qemu-guest-agent
+
    +
    • +
+
+
+
+ +
+

Installation Process

+

After configuring the VM settings and disk options, the script will:

+
    +
  1. Create the VM with the specified configuration
    2. +
  2. Configure EFI disk if UEFI BIOS is selected
    3. +
  3. Create and attach virtual disks or pass through physical disks
    4. +
  4. Mount the installation ISO
    5. +
  5. Set the boot order (disk first, then ISO)
    6. +
  6. Configure the QEMU Guest Agent
    7. +
  7. Generate a detailed HTML description for the VM
    8. +
  8. Start the VM if requested
    9. +
+

+ Once the VM is created, you can proceed with the installation of your chosen NAS system by following the + on-screen instructions in the VM console. +

+
+ +
+

NAS Systems Interfaces

+

+ Below are screenshots of the shell and web interfaces for each NAS system after successful installation: +

+ + {/* TrueNAS SCALE */} +
+

+ + TrueNAS SCALE + + Official Website + +

+
+
+

Shell Interface

+
+ TrueNAS SCALE Shell Interface +
+
+
+

Web Interface

+
+ TrueNAS SCALE Web Interface +
+
+
+
+ + {/* TrueNAS CORE */} +
+

+ + TrueNAS CORE + + Official Website + +

+
+
+

Shell Interface

+
+ TrueNAS CORE Shell Interface +
+
+
+

Web Interface

+
+ TrueNAS CORE Web Interface +
+
+
+
+ + {/* OpenMediaVault */} +
+

+ + OpenMediaVault + + Official Website + +

+
+
+

Shell Interface

+
+ OpenMediaVault Shell Interface +
+
+
+

Web Interface

+
+ OpenMediaVault Web Interface +
+
+
+
+ + {/* Rockstor */} +
+

+ + Rockstor + + Official Website + +

+
+
+

Shell Interface

+
+ Rockstor Shell Interface +
+
+
+

Web Interface

+
+ Rockstor Web Interface +
+
+
+
+
+
+
+ ) +} diff --git a/web/public/vm/rockstor/local-store-windows.png b/web/public/vm/rockstor/local-store-windows.png new file mode 100644 index 0000000..00bff32 Binary files /dev/null and b/web/public/vm/rockstor/local-store-windows.png differ