Projects STRLCPY pikvm Commits 0ebc6fe7
🤬
  • ■ ■ ■ ■
    README.md
    skipped 23 lines
    24 24  * Supported **Raspberry Pi 2**, **3**, **4** and **Zero2W**;
    25 25  * **FullHD video** using advanced **HDMI-to-CSI bridge** or **USB dongle**;
    26 26  * Extra low **video latency** with **MJPEG** or **H.264 / WebRTC** (for CSI bridge);
    27  -* Bootable **Virtual CD-ROM** and **Flash Drive**;
     27 +* Bootable **Virtual CD-ROM** and **Flash Drive**, ability to store images on **NFS**;
    28 28  * USB **Keyboard** and **mouse** (with leds and the wheel), PS/2 keyboard, Bluetooth HID;
    29 29  * **Control the server power** using ATX functions;
    30 30  * Access via **Web UI** or **VNC**;
    skipped 872 lines
  • ■ ■ ■ ■ ■ ■
    docs/msd.md
    skipped 16 lines
    17 17   The switch affects the settings of the future connection. For non-v3 devices,
    18 18   you need to either reboot your server or otherwise reinitialize the connection.
    19 19   
    20  -!!! warning "Advanced Linux knowledge is necessary for some advanced aspects that are not part of the normal use case. IE: making larger flash files will need a different file location and those instructions will need to be modified. The following instructions are for you to have something to start with."
    21  - 
    22 20  -----
    23  -## Disable MSD
    24  - 
    25  -To disable mass storage emulation altogether, you can place the following piece of configuration into `/etc/kvmd/override.yaml`:
    26  - 
    27  -``` yaml
    28  -kvmd:
    29  - msd:
    30  - type: disabled
    31  -```
    32  - 
    33  - 
    34 21  ## Upload images manually (without Web UI)
    35 22   
    36  -!!! warning "This instruction is relevant for KVM >= 3.203. If you are using a previous version, then update OS."
     23 +!!! info "This instruction is relevant for KVM >= 3.203. If you are using a previous version, then update OS."
    37 24   
    38 25  1. Remount internal storage to rw (read-write):
    39 26   
    skipped 18 lines
    58 45   
    59 46   
    60 47  -----
     48 +## NFS storage
     49 + 
     50 +!!! info "This instruction is relevant for KVM >= 3.206. If you are using a previous version, then update OS."
     51 + 
     52 +It is possible to create a shared image storage for an entire fleet of PiKVMs using [NFS](https://en.wikipedia.org/wiki/Network_File_System).
     53 + 
     54 +If you have some shares, you can easily connect them to PiKVM by creating mount points and adding relevant records to `/etc/fstab`.
     55 +At the same time, you will be able to upload images via PiKVM Web UI to NFS, and still use local storage.
     56 + 
     57 +```
     58 +# kvmd-helper-otgmsd-remount rw
     59 +# mkdir -p /var/lib/kvmd/msd/NFS_Primary
     60 +# mkdir -p /var/lib/kvmd/msd/NFS_Secondary
     61 +# kvmd-helper-otgmsd-remount ro
     62 +```
     63 + 
     64 +```fstab
     65 +server:/srv/nfs/NFS_Primary /var/lib/kvmd/msd/NFS_Primary nfs vers=3,timeo=1,retrans=1,soft 0 0
     66 +server:/srv/nfs/NFS_Secondary /var/lib/kvmd/msd/NFS_Secondary nfs vers=3,timeo=1,retrans=1,soft 0 0
     67 +```
     68 + 
     69 +Make sure that the `kvmd` user has read access rights from these directories. You can also give write access if needed.
     70 +For the best performance, it is required to ensure reliable connectivity with NFS server and use minimum `timeo` and `retrans` values.
     71 + 
     72 +Configuring an NFS server is beyond the scope of this guide.
     73 + 
     74 + 
     75 +-----
    61 76  ## Multiple and writable drives
    62 77   
    63 78  Unless explicitly [disabled](#disable-msd) by default, PiKVM creates only one drive for Mass Storage emulation.
    skipped 27 lines
    91 106  3. Perform `reboot`.
    92 107   
    93 108   
    94  -### How to create RW flash drive
     109 +### How to create a second RW flash drive
    95 110   
    96 111  1. Switch the root filesystem to `rw` mode:
    97 112   
    skipped 42 lines
    140 155   
    141 156   
    142 157  -----
     158 +## Disable MSD
     159 + 
     160 +To disable mass storage emulation altogether, you can place the following piece of configuration into `/etc/kvmd/override.yaml`:
     161 + 
     162 +``` yaml
     163 +kvmd:
     164 + msd:
     165 + type: disabled
     166 +```
     167 + 
     168 + 
     169 +-----
    143 170  ## Create a Windows based Flash disk image
    144 171   
    145 172  An alternative version of this can be found below that does not require a physical usb flash
    skipped 90 lines
    236 263  * There is an assumption that you know basic linux to understand that not all dev devices are named exactly like the below
    237 264   
    238 265  ```
    239  -dd if=/dev/zero of=ventoy.img bs=1M count=4700 status=progress
     266 +# dd if=/dev/zero of=ventoy.img bs=1M count=4700 status=progress
    240 267  ```
    241 268   
    242 269  * This makes a ventoy.img file, I would name this what it is EG: `ventoy_win10.img`
    skipped 3 lines
    246 273  * At the time of this, it was 1.0.51, change to latest version
    247 274   
    248 275  ```
    249  -wget https://github.com/ventoy/Ventoy/releases/download/v1.0.51/ventoy-1.0.51-linux.tar.gz
    250  -tar zxvf ventoy-1.0.51-linux.tar.gz
    251  -sudo losetup -f ventoy.img
    252  -sudo losetup -l | grep ventoy (To locate which loop device was used)
    253  -sudo sh ~/ventoy-1.0.51/Ventoy2Disk.sh -i /dev/loopXX (This will make a loopXXp1 and a loopXXp2 and will format both partitions
    254  -cd /media/XXX (Usually your login)
    255  -mkdir ventoy
    256  -sudo mount /dev/loopXXp1 /media/XXX/ventoy
     276 +# wget https://github.com/ventoy/Ventoy/releases/download/v1.0.51/ventoy-1.0.51-linux.tar.gz
     277 +# tar zxvf ventoy-1.0.51-linux.tar.gz
     278 +# sudo losetup -f ventoy.img
     279 +# sudo losetup -l | grep ventoy (To locate which loop device was used)
     280 +# sudo sh ~/ventoy-1.0.51/Ventoy2Disk.sh -i /dev/loopXX (This will make a loopXXp1 and a loopXXp2 and will format both partitions
     281 +# cd /media/XXX (Usually your login)
     282 +# mkdir ventoy
     283 +# sudo mount /dev/loopXXp1 /media/XXX/ventoy
    257 284  ```
    258 285   
    259 286  * Either cp/scp over the .iso you downloaded from the Media tool or use a NFS mount
    skipped 11 lines
    271 298  * On PiKVM
    272 299   
    273 300  ```
    274  -cd /var/lib/kvmd/msd
    275  -mount -o remount,rw .
     301 +# cd /var/lib/kvmd/msd
     302 +# mount -o remount,rw .
    276 303  ```
    277 304   
    278 305  * On Ubuntu
    279 306   
    280 307  ```
    281  -scp ventoy.img root@pikvm:/var/lib/kvmd/msd
     308 +# scp ventoy.img root@pikvm:/var/lib/kvmd/msd
    282 309  ```
    283 310   
    284 311  * On PiKVM
    285 312   
    286 313  ```
    287  -touch /var/lib/kvmd/msd/.__ventoy.img.complete
     314 +# touch /var/lib/kvmd/msd/.__ventoy.img.complete
    288 315  ```
    289 316   
    290 317  * Mount `ventoy.img` as normal flash and select the PiKVM boot device, it should popup with the VenToy logo with the window.iso as a selection
    skipped 1 lines
Please wait...
Page is in error, reload to recover