Ventoy

https://www.ventoy.net/en/
Admin
Ventoy is an open source tool to create bootable USB drives that support multiple...
Tokens:61,809
Snippets:962
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Basic Auto Install Configuration

Source: https://www.ventoy.net/en/plugin_path_match.html

Example of specifying a fixed ISO path for the auto_install plugin.

```json
{
    "auto_install": [
        {
            "image": "/ISO/CentOS/CentOS-7-x86_64-DVD-1810.iso",
            "template": "/ventoy/script/centos_kickstart.cfg"
        }
    ]
}
```

--------------------------------

### Ventoy Command Line Examples

Source: https://www.ventoy.net/en/doc_windows_cli.html

Common usage patterns for installing and updating Ventoy, including options for GPT, non-USB checks, and reserved space.

```text
Ventoy2Disk.exe VTOYCLI /U /Drive:D:
Ventoy2Disk.exe VTOYCLI /U /PhyDrive:1

Ventoy2Disk.exe VTOYCLI /I /Drive:D:
Ventoy2Disk.exe VTOYCLI /I /Drive:D: /GPT /NOUSBCheck
Ventoy2Disk.exe VTOYCLI /I /PhyDrive:2 /GPT /NOUSBCheck /NOSB /R:4096
```

--------------------------------

### Comprehensive ventoy.json Configuration

Source: https://www.ventoy.net/en/plugin_dual_option.html

A full example demonstrating both control and theme settings across multiple boot modes.

```json
{
    "control_legacy": [
        { "VTOY_DEFAULT_MENU_MODE": "1" },
        { "VTOY_FILT_DOT_UNDERSCORE_FILE": "1" }
    ],

    "control_uefi": [
        { "VTOY_DEFAULT_MENU_MODE": "0" },
        { "VTOY_FILT_DOT_UNDERSCORE_FILE": "1" }
    ],

    "control_ia32": [
        { "VTOY_DEFAULT_MENU_MODE": "0" },
        { "VTOY_FILT_DOT_UNDERSCORE_FILE": "1" }
    ],

    "control_aa64": [
        { "VTOY_DEFAULT_MENU_MODE": "0" },
        { "VTOY_FILT_DOT_UNDERSCORE_FILE": "1" }
    ],

    "control_mips": [
        { "VTOY_DEFAULT_MENU_MODE": "0" },
        { "VTOY_FILT_DOT_UNDERSCORE_FILE": "1" }
    ],

    "theme_legacy": {
        "display_mode": "CLI"
    },

    "theme_uefi": {
        "file": "/ventoy/theme/theme.txt",
        "gfxmode": "1920x1080"
    },

    "theme_ia32": {
        "file": "/ventoy/theme/theme.txt",
        "gfxmode": "800x600"
    },

    "theme_aa64": {
        "file": "/ventoy/theme/theme.txt",
        "gfxmode": "1024x768"
    },

    "theme_mips": {
        "file": "/ventoy/theme/theme.txt",
        "gfxmode": "1024x768"
    }
}
```

--------------------------------

### Example ventoy.json configuration

Source: https://www.ventoy.net/en/plugin_entry.html

A sample configuration file demonstrating control settings, theme definitions, and auto-installation templates.

```json
{
    "control": [
        { "VTOY_DEFAULT_MENU_MODE": "1" },
        { "VTOY_FILT_DOT_UNDERSCORE_FILE": "1" }
    ],

    "theme": {
        "file": "/ventoy/theme/blur/theme.txt",
        "gfxmode": "1920x1080"
    },

    "auto_install" : [
        {
            "image": "/ISO/cn_windows_server_2012_r2_vl_x64_dvd_2979220.iso",
            "template": "/ventoy/script/windows_unattended.xml"
        },
        {
            "image": "/000/centos.iso",
            "template": "/ventoy/script/centos_kickstart.cfg"
        }
    ]
}
```

--------------------------------

### Ventoy GRUB Shell Example

Source: https://www.ventoy.net/en/faq.html

This is an example of the GNU GRUB version 2.04 minimal BASH-like line editing interface that may appear if Ventoy fails to boot correctly. It indicates potential issues with the USB stick or BIOS limitations.

```bash
                             GNU GRUB  version 2.04

   Minimal BASH-like line editing is supported. For the first word, TAB
   lists possible command completions. Anywhere else TAB lists possible
   device or file completions. ESC at any time exits.

grub>
```

--------------------------------

### Launch Ventoy GUI on Linux

Source: https://www.ventoy.net/en/doc_linux_gui.html

Execute the appropriate binary for your architecture from the terminal to start the Ventoy GUI.

```bash
./VentoyGUI.x86_64
```

--------------------------------

### Launch Ventoy WebUI

Source: https://www.ventoy.net/en/doc_linux_webui.html

Start the Ventoy web interface using the default local address.

```bash
sudo bash VentoyWeb.sh
```

--------------------------------

### Run Ventoy2Disk.sh manually

Source: https://www.ventoy.net/en/doc_livecd.html

Execute the installation script from the shell to install Ventoy to a specific device.

```bash
cd /ventoy
sh Ventoy2Disk.sh -i -g /dev/sdb
```

--------------------------------

### Custom GRUB2 Menu Configuration

Source: https://www.ventoy.net/en/plugin_grubmenu.html

Example of a custom GRUB2 configuration file structure including a menu entry and a submenu with a return option.

```grub2
menuentry "My Custom Menu" --class=custom {
    echo 'This is custom menu ... '
    sleep 1
}

submenu 'My Custom SubMenu -->' --class=customsub {
    menuentry "My Custom Menu2" --class=custom2 {
        echo 'This is custom menu2 ... '
        sleep 1
    }

    menuentry '<-- Return to previous menu [Esc]' --class=vtoyret VTOY_RET {
        echo 'Return ...'
    }
}

menuentry '<-- Return to previous menu [Esc]' --class=vtoyret VTOY_RET {
    echo 'Return ...'
}
```

--------------------------------

### Initialize Diskpart in Command Prompt

Source: https://www.ventoy.net/en/experience_windows-10-boot-repair.html

Start the Diskpart utility from the Windows Command Prompt to manage disk partitions and volumes.

```bash
diskpart
```

--------------------------------

### Example ISO and Checksum File Naming

Source: https://www.ventoy.net/en/doc_checksum.html

Illustrates the naming convention for ISO files and their corresponding checksum files (.md5, .sha1, .sha256, .sha512). Ensure the checksum file has an additional suffix appended to the original filename.

```text
/ISO/Linux/tails-amd64-4.23.iso
/ISO/Linux/tails-amd64-4.23.iso.md5
/ISO/Linux/tails-amd64-4.23.img
/ISO/Linux/tails-amd64-4.23.img.md5

/ISO/Windows/en_Windows11.iso
/ISO/Windows/en_Windows11.iso.sha1

/ISO/ChromeOS/cloudready-free-92.3.4-64bit.img
/ISO/ChromeOS/cloudready-free-92.3.4-64bit.img.sha256
```

--------------------------------

### Configure Ventoy Injection Plugin

Source: https://www.ventoy.net/en/doc_inject_autorun.html

Example configuration for the ventoy.json file to include the injection archive.

```json
{
    "injection": [
        {
            "image": "/ISO/Windows10x86x64.iso",
            "archive": "/windows_injection.7z"
        }
    ]
}
```

--------------------------------

### Configure Default Image with Special Values

Source: https://www.ventoy.net/en/plugin_control.html

Examples of setting the default image behavior using special keywords or hotkey menu paths in the control configuration.

```json
{
    "control": [
        { "VTOY_MENU_TIMEOUT": "10" },
        { "VTOY_DEFAULT_IMAGE": "VTOY_EXIT" }
    ]
}
```

```json
{
    "control": [
        { "VTOY_MENU_TIMEOUT": "10" },
        { "VTOY_DEFAULT_IMAGE": "F5>Power>Halt" }
    ]
}
```

```json
{
    "control": [
        { "VTOY_MENU_TIMEOUT": "10" },
        { "VTOY_DEFAULT_IMAGE": "F4>Search and boot Windows" }
    ]
}
```

```json
{
    "control": [
        { "VTOY_MENU_TIMEOUT": "10" },
        { "VTOY_DEFAULT_IMAGE": "F4>Boot the 1st local disk" }
    ]
}
```

```json
{
    "control": [
        { "VTOY_MENU_TIMEOUT": "10" },
        { "VTOY_DEFAULT_IMAGE": "F5>Check plugin json configuration (ventoy.json)>Check theme plugin configuration" }
    ]
}
```

--------------------------------

### Configure auto_install in ventoy.json

Source: https://www.ventoy.net/en/plugin_autoinstall.html

Define the auto_install array in /ventoy/ventoy.json to map ISO images or parent directories to specific installation templates. Use the autosel property to pre-select a template index and timeout to control the selection menu duration.

```json
{
    "auto_install": [
        {
            "image": "/abc/centos.iso",
            "template": "/ventoy/script/centos_kickstart.cfg"
        },
        {
            "image": "/ISO/cn_windows_server_2012_r2_vl_x64_dvd_2979220.iso",
            "template": [
                "/ventoy/script/windows_unattended1.xml",
                "/ventoy/script/windows_unattended2.xml",
                "/ventoy/script/windows_unattended3.xml",
                "/ventoy/script/windows_unattended4.xml",
                "/ventoy/script/windows_unattended5.xml",
                "/ventoy/script/windows_unattended6.xml"
            ],
            "autosel": 2
        },
        {
            "image": "/ISO/cn_windows_server_2016.iso",
            "template": [
                "/ventoy/script/windows_unattended7.xml",
                "/ventoy/script/windows_unattended8.xml",
                "/ventoy/script/windows_unattended9.xml"
            ],
            "autosel": 3,
            "timeout": 10
        },
        {
            "image": "/SLE-12-SP3-Server-DVD-x86_64-GM-DVD1.iso",
            "template": "/ventoy/script/suse_autoyast.xml"
        },
        {
            "parent": "/ISO/SUSE",
            "template": "/ventoy/script/suse_autoyast.xml"
        },
        {
            "image": "/ubuntu-16.04-server-amd64.iso",
            "template": "/ventoy/script/ubuntu_server.seed",
            "autosel": 1
        }
    ]
}
```

--------------------------------

### Perform Non-destructive Installation on Linux

Source: https://www.ventoy.net/en/doc_non_destructive.html

Use the -n option with the installation command to perform a non-destructive install on a Linux device.

```bash
sudo sh Ventoy2Disk.sh -i -n /dev/sdb
```

--------------------------------

### Salted MD5 Password Examples

Source: https://www.ventoy.net/en/plugin_password.html

Examples of MD5 hashes generated using different salt values for the same password.

```text
md5#a#dc483e80a7a0bd9ef71d8cf973673924
md5#b#8df32286deed62bae5bf746672805c78
md5#c#ad07fb25aa2d3a9f96ee12f25e0be902
md5#d#adf00707a1c0154a9ad8edb57c8646f4
```

--------------------------------

### Verify Configuration File Paths

Source: https://www.ventoy.net/en/plugin_bootconf_replace.html

Use the GRUB shell to inspect the ISO file structure and verify the exact path of the configuration file to be replaced.

```bash
loopback viso $vtoy_iso_part/manjaro-xfce-20.1.2-201019-linux58.iso
ls (viso)/
ls (viso)/boot/
ls (viso)/boot/grub/
```

--------------------------------

### Install or Update Ventoy via Linux CLI

Source: https://www.ventoy.net/en/doc_start.html

Use the Ventoy2Disk.sh script to manage Ventoy installations on Linux devices. Ensure the script is run with root privileges.

```bash
Ventoy2Disk.sh CMD [ OPTION ] /dev/sdX
  CMD:
    -i   install ventoy to sdX (fail if disk already installed with ventoy)
    -I   force install ventoy to sdX (no matter installed or not)
    -u   update ventoy in sdX
    -l   list Ventoy information in sdX

  OPTION: (optional)
   -r SIZE_MB  preserve some space at the bottom of the disk (only for install)
   -s          enable secure boot support (default is disabled)
   -g          use GPT partition style, default is MBR style (only for install)
   -L          Label of the main partition (default is Ventoy)
```

--------------------------------

### List Installed Packages using DISM

Source: https://www.ventoy.net/en/experience_windows-10-boot-repair.html

Use DISM to list all installed updates on your computer. Replace 'C:\\' with your system drive letter if it's different.

```bash
dism /Image:C:\\ /get-packages /format:list
```

--------------------------------

### List Installed Drivers in Windows Recovery

Source: https://www.ventoy.net/en/experience_windows-11-boot-repair.html

Use this command in the Windows Recovery Environment (WinRE) Command Prompt to list all drivers installed on your system. This helps identify drivers to uninstall if they are causing boot issues.

```bash
Dism /online /Get-Drivers / all /Format:Table
```

--------------------------------

### Create Bootable Media with EaseUS Partition Master

Source: https://www.ventoy.net/en/experience_windows-10-wont-boot.html

Use this process to create a bootable WinPE media for repairing Windows boot issues. Ensure you have a USB drive or CD/DVD available.

```bash
Launch EaseUS Partition Master, and click "Bootable Media" on the toolbar. Select "Create bootable media".
Click "Next" to finish the process.
```

--------------------------------

### Ventoy Password Configuration Object

Source: https://www.ventoy.net/en/plugin_password.html

Example structure for the password configuration object within the ventoy.json file.

```json
{
    "password": {
        "bootpwd": "txt#123456",
        "isopwd": "txt#111",
        "wimpwd": "txt#222",
        "imgpwd": "txt#333",
        "vhdpwd": "txt#444",
        "efipwd": "txt#555",
        "vtoypwd": "txt#666",
        "menupwd": [
            {
                "parent":"/MyVhdDir/WindowsVHD",
                "pwd":"md5#def#14fa11b4ab450b0204182266140e284d"
            },
            {
                "file":"/ISO/MX-19.1_x64.iso",
                "pwd":"md5#e10adc3949ba59abbe56e057f20f883e"
            },
            {
                "file":"/ISO/ubuntu-20.04-desktop-amd64.iso",
                "pwd":"md5#abc#0659c7992e268962384eb17fafe88364"
            }
        ]
    }
}
```

--------------------------------

### Define Multiple Theme Files

Source: https://www.ventoy.net/en/plugin_theme.html

Demonstrates using a string array for the file property to provide multiple theme options.

```json
"file": [
    "/ventoy/theme1/theme.txt",
    "/ventoy/theme2/theme.txt",
    "/ventoy/theme3/theme.txt",
    "/ventoy/theme4/theme.txt"
]
```

--------------------------------

### Boot from EaseUS Partition Master Bootable USB

Source: https://www.ventoy.net/en/experience_windows-11-wont-boot.html

Instructions on how to boot your computer from a created EaseUS Partition Master bootable USB drive. This allows the tool to run before Windows loads.

```plaintext
Connect the bootable USB or CD/DVD to your PC. 
Press F2 or Del when you restart the computer to enter the BIOS screen. Set and boot your computer from "Removable Devices" or "CD-ROM Drive". Then, EaseUS Partition Master will run automatically.
```

--------------------------------

### Ventoy2Disk.exe CLI

Source: https://www.ventoy.net/en/doc_windows_cli.html

The command line interface for Ventoy2Disk.exe allows for automated installation and updates of Ventoy on specified drives.

```APIDOC
## Ventoy2Disk.exe VTOYCLI

### Description
Executes Ventoy installation or update operations via the Windows command line.

### Usage
Ventoy2Disk.exe VTOYCLI [CMD] [DISK] [Options]

### Parameters
#### Required Parameters
- **CMD** (string) - Required - The operation to perform: /I (install) or /U (update).
- **DISK** (string) - Required - The target disk. Use /Drive:F: for logical drive or /PhyDrive:1 for physical drive number.

#### Optional Parameters
- **/GPT** (flag) - Optional - Use GPT partition style (default is MBR).
- **/NOSB** (flag) - Optional - Disable Secure Boot Support.
- **/NOUSBCheck** (flag) - Optional - Skip USB type verification.
- **/R:XXX** (integer) - Optional - Reserve space at the end of the disk in MB.
- **/FS:XXX** (string) - Optional - Specify filesystem (e.g., NTFS, EXFAT, FAT32).
- **/NonDest** (flag) - Optional - Perform non-destructive installation.

### Result Files
- **cli_log.txt**: Detailed log of the process.
- **cli_percent.txt**: Progress percentage.
- **cli_done.txt**: Completion status (0 for success, 1 for failure).
```

--------------------------------

### Define GRUB2 mode tip in theme.txt

Source: https://www.ventoy.net/en/doc_grub2boot.html

Add this hbox definition to your custom theme.txt file to display the GRUB2 mode indicator.

```text
+ hbox{
    left = 30%+200
    top = 95%-50
    width = 10%
    height = 25
    + label {text = "@VTOY_GRUB2_MODE@" color = "red" align = "left"}
}
```

--------------------------------

### Add Hotkey Tips to Theme

Source: https://www.ventoy.net/en/plugin_theme.html

Include these hbox definitions in your theme.txt file to display hotkey and memory disk information.

```text
+ hbox{
    left = 30%
    top = 95%
    width = 10%
    height = 25
    + label {text = "@VTOY_HOTKEY_TIP@" color = "blue" align = "left"}
}

+ hbox{
    left = 90%
    top = 5
    width = 10%
    height = 25
    + label {text = "@VTOY_MEM_DISK@" color = "red" align = "left"}
}
```

--------------------------------

### Process combined-squashfs.img for Ventoy

Source: https://www.ventoy.net/en/doc_openwrt.html

Use the ventoy_openwrt_squashfs.sh script to prepare squashfs images for booting. Ensure the script and image are available before execution.

```bash
sh ventoy_openwrt_squashfs.sh  openwrt-xxx-combined-squashfs.img.gz
```

```bash
sh ventoy_openwrt_squashfs.sh  openwrt-19.07.7-x86-64-combined-squashfs.img.gz
```

--------------------------------

### Create vlnk files via Command Line

Source: https://www.ventoy.net/en/doc_vlnk.html

Use command line arguments with VentoyVlnk.exe on Windows or the shell script on Linux to generate vlnk files for local images.

```bash
VentoyVlnk.exe -s
```

```bash
VentoyVlnk.exe -i xxx.iso -o xxx.vlnk.iso
```

```bash
sudo bash VentoyVlnk.sh -c xxx.iso
```

--------------------------------

### Configure Multiple Themes by Resolution

Source: https://www.ventoy.net/en/plugin_theme.html

Define a list of theme files to be used for different display resolutions.

```json
"file": [
    "/ventoy/themes/theme_800x600/theme.txt",
    "/ventoy/themes/theme_1024x768/theme.txt",
    "/ventoy/themes/theme_1600x900/theme.txt"
]
```

```json
"file": [
    "/ventoy/themes/theme_800x600_1/theme.txt",
    "/ventoy/themes/theme_800x600_2/theme.txt",
    "/ventoy/themes/theme_800x600_3/theme.txt",
    "/ventoy/themes/theme_1024x768_1/theme.txt",
    "/ventoy/themes/theme_1024x768_2/theme.txt",
    "/ventoy/themes/theme_1024x768_3/theme.txt",
    "/ventoy/themes/theme_1600x900_1/theme.txt",
    "/ventoy/themes/theme_1600x900_2/theme.txt",
    "/ventoy/themes/theme_1600x900_3/theme.txt"
]
```
Tokens:
Raw