supplement msd guide

ThomasVon2021 · Sep 3, 2023 · 82fbfee · 82fbfee
1 parent 07ce8d0
commit 82fbfee
Show file tree

Hide file tree

Showing 34 changed files with 285 additions and 150 deletions.
diff --git a/docs/en/BLIKVM-HAT-guide.md b/docs/en/BLIKVM-HAT-guide.md
@@ -9,6 +9,22 @@ ATX adapter,PoE, OLED and RTC. The product has a customized metal case to dissip
 for the HAT. The product can be easily installed on a standard 1U rack. The product is currently perfectly compatible
 with blikvm image and pikvm image.  
  ![Image title](assets/images/BLIKVM-HAT/case.png){width="300"}  
+
+ ## Features
+- **Video capture** (HDMI, support 1080P@50Hz input)
+- **Keyboard forwarding**
+- **Mouse forwarding**
+- **Mass Storage Drive**
+- **ATX** Control the server power using ATX functions
+- **Fullscreen mode**
+- Access via **Web UI**
+- Support **multi language** switching
+- Support **PoE**
+- **Serial** console port
+- **OLED** display
+- **Real Time Clock (RTC)**  
+- **PWM FAN**  
+
 ## **Installation requirements**
 !!! note "If you have an assembly kit, you will need the following things"
     * Raspberry Pi 4B with 1Gb RAM or more.

diff --git a/docs/en/BliKVM-v4-guide.md b/docs/en/BliKVM-v4-guide.md
@@ -24,7 +24,7 @@ BliKVM v4 is a production-ready, plug and play KVM-over-IP device that offers pr
 
 ## Installation Requirements
 !!! note "In addition to the v4 kit, you will need the following equipment:"
-    * Power adapter (5V 3A, USB-A port, or 12V 2A DC port). If you plan to use PoE (Power over Ethernet) or if the USB ports on your controlled computers provide sufficient power, a separate power adapter is not required.
+    * Power adapter (5V 3A, USB-C port, or 12V 2A DC port). If you plan to use PoE (Power over Ethernet) or if the USB ports on your controlled computers provide sufficient power, a separate power adapter is not required.
     * HDMI cables (at least one). If you also need to use the HDMI loop-out interface, you will need two cables.
     * Ethernet cable(s) (provide based on your requirements). One cable is required for using the ATX power switch function, and one cable is required for using the Ethernet connection.
     * USB-C to USB-A cable (for mouse and keyboard data transmission).

diff --git a/docs/en/Expand_Filesystem.md b/docs/en/Expand_Filesystem.md
@@ -35,7 +35,8 @@ sudo raspi-config
 
 ## Method 3: Use script
 - If you are using a BliKVM image, you can run the following script on KVM to automatically expand the space.
-**1.** Log in to the KVM terminal, confirm that the system has read and write permissions, run `vim expand. sh` on any path, and write the following content to expand.sh
+**1.** Log in to the KVM terminal, confirm that the system has read and write permissions, run `vim expand. sh` on any path, and write the following content to expand.sh.  
+If your hardwawre is v1,v2 or v3, use:
 ```
 #!/bin/bash
 set -x
@@ -51,6 +52,23 @@ echo "Starting partition resizing..."
 
 resize_mmcblk0p3
 
+echo "Partition resizing completed."
+```
+If your hardwawre is v4, use:
+```
+#!/bin/bash
+set -x
+
+resize_mmcblk0p1() {
+  echo "Resizing mmcblk0p1 partition..."
+  parted /dev/mmcblk0 resizepart 1 100%
+  resize2fs /dev/mmcblk0p1
+  echo "mmcblk0p1 partition resized successfully."
+}
+
+echo "Starting partition resizing..."
+
+resize_mmcblk0p1
 echo "Partition resizing completed."
 ```
 

diff --git a/docs/en/msd.md b/docs/en/msd.md
@@ -7,9 +7,16 @@ BliKVM's USB device simulation feature allows you to remotely mount images on th
 Note: the size of the MSD is limited by the size of your sd card or eMMC module.
 
 ## Web UI
-Currently, except for uploading images that are not yet supported, all other tasks can be completed through the web UI
+The entrance to the MSD virtual USB drive is as follows:
 ![](assets/images/msd/web-ui.png)
 
+!!! warning "Using the web to upload images and create bootable drives are both synchronous processes. If you exit the MSD UI interface after uploading an image, you can resume the upload from where it left off the next time you select the same image. However, once you exit the bootable drive creation process, you cannot resume it; you will need to start over."
+    - The default upload path for images is /mnt/upload. If an upload fails, you can manually delete the cache files that were not successfully uploaded.
+    - Due to the large size of some image files, image uploads are divided into slices and then merged. The merging process cannot be resumed, so please ensure you wait for the merge to complete (which may take some time) before proceeding to the next step.  
+    - Creating a bootable drive involves two steps: creating a virtual USB drive and copying the selected ISO image into the created virtual USB drive. Both steps have progress indicators. Please wait until both steps show 100% progress before clicking the next button.
+    ![](assets/images/msd/progress.png){width="300"}
+    ![](assets/images/msd/merger.png){width="300"}  
+
 ## Upload images manually (without Web UI)
 
 1. Confirm that the following four paths exist. If you are using the official latest image of blikvm, and it is fully configured, there is no need to check.

diff --git a/docs/zh/BliKVM-v4-guide.md b/docs/zh/BliKVM-v4-guide.md
@@ -24,12 +24,12 @@ BliKVM v4是一款生产就绪、即插即用的 KVM-over-IP 设备，为专业
 
 ## **安装要求**
 !!! note "除v4套件外，您还需自备以下设备"
-    * 电源适配器（5V 3A, USB-A端口或12V 2ADC端口）,若你计划使用PoE供电，或者所的被控计算机USB口有充足的供电能力，则也不需要单独的电源适配器；
+    * 电源适配器（5V 3A, USB-C端口或12V 2ADC端口）,若你计划使用PoE供电，或者所的被控计算机USB口有充足的供电能力，则也不需要单独的电源适配器；
     * HDMI 线缆(至少一根)，若您同时需要使用HDMI环出接口，则需要2根；
     * 网线（结合您需求自备）,使用ATX开关机功能需一根，使用网线上网功能需一根；
     * USB-C转USB-A线缆一根（用于鼠标和键盘数据传输）.
 
-!!! warning "升级注意！"
+!!! warning "终端升级注意！"
     在升级前，需执行下面命令，否则apt-get update 和 apt-get upgrade后镜像会无法启动
     ```
     apt-mark hold linux-dtb-edge-sunxi64 linux-image-edge-sunxi64

diff --git a/docs/zh/Expand_Filesystem.md b/docs/zh/Expand_Filesystem.md
@@ -37,6 +37,7 @@ sudo raspi-config
 ## 方法三: 使用脚本
 - 如果你使用的是BliKVM镜像，可以在KVM上运行下面的脚本，来自动扩大空间。
 **1.** 终端登录到KVM上，确认系统有可读写权限，在任意路径运行`vim expand.sh`,将下面内容写入到expand.sh中. 
+如果你是v1,v2,v3版本，请使用下面内容：
 ```
 #!/bin/bash
 set -x
@@ -54,7 +55,23 @@ resize_mmcblk0p3
 
 echo "Partition resizing completed."
 ```
+如果你是v4版本，请使用下面内容：
+```
+#!/bin/bash
+set -x
+
+resize_mmcblk0p1() {
+  echo "Resizing mmcblk0p1 partition..."
+  parted /dev/mmcblk0 resizepart 1 100%
+  resize2fs /dev/mmcblk0p1
+  echo "mmcblk0p1 partition resized successfully."
+}
 
+echo "Starting partition resizing..."
+
+resize_mmcblk0p1
+echo "Partition resizing completed."
+```
 **2.** 终端执行`bash expand.sh`,等待执行完成即可。
 
 - 如果你使用的是PiKVM的镜像，可以在KVM上运行下面的脚本，来自动扩大空间。

diff --git a/docs/zh/msd.md b/docs/zh/msd.md
@@ -5,9 +5,16 @@
 BliKVM支持U盘设备模拟，通过此功能可以进行远程挂载镜像，进行重装系统。
 
 ## Web UI
-当前除上传镜像还不支持外，其它均可通过web ui完成。
+msd虚拟U盘入口为:
 ![](assets/images/msd/web-ui.png)
 
+!!! warning "使用web上传镜像和制作启动盘，均是同步线程，上传镜像退出MSD的UI界面后，下次再选择相同镜像可断点续传。制作启动盘推出后不可断点重做，需重新开始。"
+    - 上传镜像默认路径为/mnt/upload,若出现上传失败，删除为成功的缓存文件，可手动删除此文件夹；
+    - 因部分镜像文件大小较大，采取上传镜像方案为切片上传和合并，合并过程不能断点重来，切记等待合并完成后(时间较长)，再进入下一步；  
+    - 制作启动盘也很为两个步骤，制作虚拟U盘，将选择的iso镜像拷贝到制作好的虚拟U盘里，两个步骤均有进度，请等两者进度均100%后再点击下一步按钮。 
+    ![](assets/images/msd/progress.png){width="300"}
+    ![](assets/images/msd/merger.png){width="300"}  
+
 ## 手动 (不使用Web UI)
 
 !!! info "1. 确认系统存在下面4个路径。如果你使用的是最新的BliKVM镜像，无需进行检查。其中/opt/bin/msd/user路径用于存放系统镜像。"

diff --git a/generated/en/BLIKVM-HAT-guide/index.html b/generated/en/BLIKVM-HAT-guide/index.html
@@ -582,6 +582,20 @@ <h2 id="introduction"><strong>Introduction</strong></h2>
 for the HAT. The product can be easily installed on a standard 1U rack. The product is currently perfectly compatible
 with blikvm image and pikvm image.<br/>
 <a class="glightbox" data-desc-position="bottom" data-height="auto" data-width="100%" href="../assets/images/BLIKVM-HAT/case.png"><img alt="Image title" src="../assets/images/BLIKVM-HAT/case.png" width="300"/></a> </p>
+<p>## Features
+- <strong>Video capture</strong> (HDMI, support 1080P@50Hz input)
+- <strong>Keyboard forwarding</strong>
+- <strong>Mouse forwarding</strong>
+- <strong>Mass Storage Drive</strong>
+- <strong>ATX</strong> Control the server power using ATX functions
+- <strong>Fullscreen mode</strong>
+- Access via <strong>Web UI</strong>
+- Support <strong>multi language</strong> switching
+- Support <strong>PoE</strong>
+- <strong>Serial</strong> console port
+- <strong>OLED</strong> display
+- <strong>Real Time Clock (RTC)</strong><br/>
+- <strong>PWM FAN</strong> </p>
 <h2 id="installation-requirements"><strong>Installation requirements</strong></h2>
 <div class="admonition note">
 <p class="admonition-title">If you have an assembly kit, you will need the following things</p>

diff --git a/generated/en/BliKVM-v4-guide/index.html b/generated/en/BliKVM-v4-guide/index.html
@@ -521,7 +521,7 @@ <h2 id="installation-requirements">Installation Requirements</h2>
 <div class="admonition note">
 <p class="admonition-title">In addition to the v4 kit, you will need the following equipment:</p>
 <ul>
-<li>Power adapter (5V 3A, USB-A port, or 12V 2A DC port). If you plan to use PoE (Power over Ethernet) or if the USB ports on your controlled computers provide sufficient power, a separate power adapter is not required.</li>
+<li>Power adapter (5V 3A, USB-C port, or 12V 2A DC port). If you plan to use PoE (Power over Ethernet) or if the USB ports on your controlled computers provide sufficient power, a separate power adapter is not required.</li>
 <li>HDMI cables (at least one). If you also need to use the HDMI loop-out interface, you will need two cables.</li>
 <li>Ethernet cable(s) (provide based on your requirements). One cable is required for using the ATX power switch function, and one cable is required for using the Ethernet connection.</li>
 <li>USB-C to USB-A cable (for mouse and keyboard data transmission).</li>

diff --git a/generated/en/Expand_Filesystem/index.html b/generated/en/Expand_Filesystem/index.html
@@ -492,7 +492,8 @@ <h2 id="method-3-use-script">Method 3: Use script</h2>
 <ul>
 <li>
 <p>If you are using a BliKVM image, you can run the following script on KVM to automatically expand the space.
-<strong>1.</strong> Log in to the KVM terminal, confirm that the system has read and write permissions, run <code>vim expand. sh</code> on any path, and write the following content to expand.sh
+<strong>1.</strong> Log in to the KVM terminal, confirm that the system has read and write permissions, run <code>vim expand. sh</code> on any path, and write the following content to expand.sh.<br/>
+If your hardwawre is v1,v2 or v3, use:
 <div class="highlight"><pre><span></span><code><a href="#__codelineno-1-1" id="__codelineno-1-1" name="__codelineno-1-1"></a>#!/bin/bash
 <a href="#__codelineno-1-2" id="__codelineno-1-2" name="__codelineno-1-2"></a>set -x
 <a href="#__codelineno-1-3" id="__codelineno-1-3" name="__codelineno-1-3"></a>
@@ -508,32 +509,48 @@ <h2 id="method-3-use-script">Method 3: Use script</h2>
 <a href="#__codelineno-1-13" id="__codelineno-1-13" name="__codelineno-1-13"></a>resize_mmcblk0p3
 <a href="#__codelineno-1-14" id="__codelineno-1-14" name="__codelineno-1-14"></a>
 <a href="#__codelineno-1-15" id="__codelineno-1-15" name="__codelineno-1-15"></a>echo "Partition resizing completed."
+</code></pre></div>
+If your hardwawre is v4, use:
+<div class="highlight"><pre><span></span><code><a href="#__codelineno-2-1" id="__codelineno-2-1" name="__codelineno-2-1"></a>#!/bin/bash
+<a href="#__codelineno-2-2" id="__codelineno-2-2" name="__codelineno-2-2"></a>set -x
+<a href="#__codelineno-2-3" id="__codelineno-2-3" name="__codelineno-2-3"></a>
+<a href="#__codelineno-2-4" id="__codelineno-2-4" name="__codelineno-2-4"></a>resize_mmcblk0p1() {
+<a href="#__codelineno-2-5" id="__codelineno-2-5" name="__codelineno-2-5"></a>  echo "Resizing mmcblk0p1 partition..."
+<a href="#__codelineno-2-6" id="__codelineno-2-6" name="__codelineno-2-6"></a>  parted /dev/mmcblk0 resizepart 1 100%
+<a href="#__codelineno-2-7" id="__codelineno-2-7" name="__codelineno-2-7"></a>  resize2fs /dev/mmcblk0p1
+<a href="#__codelineno-2-8" id="__codelineno-2-8" name="__codelineno-2-8"></a>  echo "mmcblk0p1 partition resized successfully."
+<a href="#__codelineno-2-9" id="__codelineno-2-9" name="__codelineno-2-9"></a>}
+<a href="#__codelineno-2-10" id="__codelineno-2-10" name="__codelineno-2-10"></a>
+<a href="#__codelineno-2-11" id="__codelineno-2-11" name="__codelineno-2-11"></a>echo "Starting partition resizing..."
+<a href="#__codelineno-2-12" id="__codelineno-2-12" name="__codelineno-2-12"></a>
+<a href="#__codelineno-2-13" id="__codelineno-2-13" name="__codelineno-2-13"></a>resize_mmcblk0p1
+<a href="#__codelineno-2-14" id="__codelineno-2-14" name="__codelineno-2-14"></a>echo "Partition resizing completed."
 </code></pre></div></p>
 </li>
 <li>
 <p>If you are using a PiKVM image, you can run the following script on KVM to automatically expand the space.
 <strong>1.</strong> Log in to the KVM terminal, confirm that the system has read and write permissions, run <code>vim expand. sh</code> on any path, and write the following content to expand.sh
-<div class="highlight"><pre><span></span><code><a href="#__codelineno-2-1" id="__codelineno-2-1" name="__codelineno-2-1"></a>#!/bin/bash
-<a href="#__codelineno-2-2" id="__codelineno-2-2" name="__codelineno-2-2"></a>set -x
-<a href="#__codelineno-2-3" id="__codelineno-2-3" name="__codelineno-2-3"></a>        if grep -q 'X-kvmd\.otgmsd' /etc/fstab; then
-<a href="#__codelineno-2-4" id="__codelineno-2-4" name="__codelineno-2-4"></a>                part=$(grep 'X-kvmd\.otgmsd' /etc/fstab | awk '{print $1}')
-<a href="#__codelineno-2-5" id="__codelineno-2-5" name="__codelineno-2-5"></a>                # shellcheck disable=SC2206
-<a href="#__codelineno-2-6" id="__codelineno-2-6" name="__codelineno-2-6"></a>                splitted=(${part//=/ })
-<a href="#__codelineno-2-7" id="__codelineno-2-7" name="__codelineno-2-7"></a>                if [ "${splitted[0]}" == LABEL ]; then
-<a href="#__codelineno-2-8" id="__codelineno-2-8" name="__codelineno-2-8"></a>                        label=${splitted[1]}
-<a href="#__codelineno-2-9" id="__codelineno-2-9" name="__codelineno-2-9"></a>                        part=$(blkid -c /dev/null -L "$label")
-<a href="#__codelineno-2-10" id="__codelineno-2-10" name="__codelineno-2-10"></a>                else
-<a href="#__codelineno-2-11" id="__codelineno-2-11" name="__codelineno-2-11"></a>                        label=PIMSD
-<a href="#__codelineno-2-12" id="__codelineno-2-12" name="__codelineno-2-12"></a>                fi
-<a href="#__codelineno-2-13" id="__codelineno-2-13" name="__codelineno-2-13"></a>                unset splitted
-<a href="#__codelineno-2-14" id="__codelineno-2-14" name="__codelineno-2-14"></a>                disk=/dev/$(lsblk -no pkname "$part")
-<a href="#__codelineno-2-15" id="__codelineno-2-15" name="__codelineno-2-15"></a>                npart=$(cat "/sys/class/block/${part//\/dev\//}/partition")
-<a href="#__codelineno-2-16" id="__codelineno-2-16" name="__codelineno-2-16"></a>                umount "$part"
-<a href="#__codelineno-2-17" id="__codelineno-2-17" name="__codelineno-2-17"></a>                parted "$disk" -a optimal -s resizepart "$npart" 100%
-<a href="#__codelineno-2-18" id="__codelineno-2-18" name="__codelineno-2-18"></a>                yes | mkfs.ext4 -L "$label" -F -m 0 "$part"
-<a href="#__codelineno-2-19" id="__codelineno-2-19" name="__codelineno-2-19"></a>                mount "$part"
-<a href="#__codelineno-2-20" id="__codelineno-2-20" name="__codelineno-2-20"></a>                unset disk part npart label
-<a href="#__codelineno-2-21" id="__codelineno-2-21" name="__codelineno-2-21"></a>        fi
+<div class="highlight"><pre><span></span><code><a href="#__codelineno-3-1" id="__codelineno-3-1" name="__codelineno-3-1"></a>#!/bin/bash
+<a href="#__codelineno-3-2" id="__codelineno-3-2" name="__codelineno-3-2"></a>set -x
+<a href="#__codelineno-3-3" id="__codelineno-3-3" name="__codelineno-3-3"></a>        if grep -q 'X-kvmd\.otgmsd' /etc/fstab; then
+<a href="#__codelineno-3-4" id="__codelineno-3-4" name="__codelineno-3-4"></a>                part=$(grep 'X-kvmd\.otgmsd' /etc/fstab | awk '{print $1}')
+<a href="#__codelineno-3-5" id="__codelineno-3-5" name="__codelineno-3-5"></a>                # shellcheck disable=SC2206
+<a href="#__codelineno-3-6" id="__codelineno-3-6" name="__codelineno-3-6"></a>                splitted=(${part//=/ })
+<a href="#__codelineno-3-7" id="__codelineno-3-7" name="__codelineno-3-7"></a>                if [ "${splitted[0]}" == LABEL ]; then
+<a href="#__codelineno-3-8" id="__codelineno-3-8" name="__codelineno-3-8"></a>                        label=${splitted[1]}
+<a href="#__codelineno-3-9" id="__codelineno-3-9" name="__codelineno-3-9"></a>                        part=$(blkid -c /dev/null -L "$label")
+<a href="#__codelineno-3-10" id="__codelineno-3-10" name="__codelineno-3-10"></a>                else
+<a href="#__codelineno-3-11" id="__codelineno-3-11" name="__codelineno-3-11"></a>                        label=PIMSD
+<a href="#__codelineno-3-12" id="__codelineno-3-12" name="__codelineno-3-12"></a>                fi
+<a href="#__codelineno-3-13" id="__codelineno-3-13" name="__codelineno-3-13"></a>                unset splitted
+<a href="#__codelineno-3-14" id="__codelineno-3-14" name="__codelineno-3-14"></a>                disk=/dev/$(lsblk -no pkname "$part")
+<a href="#__codelineno-3-15" id="__codelineno-3-15" name="__codelineno-3-15"></a>                npart=$(cat "/sys/class/block/${part//\/dev\//}/partition")
+<a href="#__codelineno-3-16" id="__codelineno-3-16" name="__codelineno-3-16"></a>                umount "$part"
+<a href="#__codelineno-3-17" id="__codelineno-3-17" name="__codelineno-3-17"></a>                parted "$disk" -a optimal -s resizepart "$npart" 100%
+<a href="#__codelineno-3-18" id="__codelineno-3-18" name="__codelineno-3-18"></a>                yes | mkfs.ext4 -L "$label" -F -m 0 "$part"
+<a href="#__codelineno-3-19" id="__codelineno-3-19" name="__codelineno-3-19"></a>                mount "$part"
+<a href="#__codelineno-3-20" id="__codelineno-3-20" name="__codelineno-3-20"></a>                unset disk part npart label
+<a href="#__codelineno-3-21" id="__codelineno-3-21" name="__codelineno-3-21"></a>        fi
 </code></pre></div></p>
 </li>
 </ul>

diff --git a/generated/en/assets/images/msd/merger.png b/generated/en/assets/images/msd/merger.png
diff --git a/generated/en/assets/images/msd/progress.png b/generated/en/assets/images/msd/progress.png