chore: add ssh config guide

ThomasVon2021 · Sep 21, 2024 · f2d07d1 · f2d07d1
1 parent 4c8cadd
commit f2d07d1
Show file tree

Hide file tree

Showing 89 changed files with 1,581 additions and 87 deletions.
diff --git a/config/en/mkdocs.yml b/config/en/mkdocs.yml
@@ -94,6 +94,7 @@ nav:
         - "HDMI EDID": edid.md
         - "User Manager": user-manager.md
         - "Wake-on-LAN": wake-on-lan.md
+        - "SSH Terminal": ssh.md 
     - "Installation Instructions":
         - "v3 HAT Illustrated Instructions": BLIHAT-Installation.md
         - "v2 PCIe Illustrated Instructions": BLIKVM-PCIe-installation.md

diff --git a/config/zh/mkdocs.yml b/config/zh/mkdocs.yml
@@ -94,6 +94,7 @@ nav:
         - "HDMI EDID设置": edid.md
         - "修改账号密码": user-manager.md
         - "Wake-on-LAN": wake-on-lan.md
+        - "SSH终端": ssh.md 
     - "安装说明":
         - "v3 HAT安装说明": BLIHAT-Installation.md
         - "v2 PCIe安装说明": BLIKVM-PCIe-installation-zh.md

diff --git a/docs/en/ssh.md b/docs/en/ssh.md
@@ -0,0 +1,11 @@
+# SSH Config
+Starting from version 1.4.7, the web interface supports direct access to the blikvm SSH terminal. The default username and password to access the terminal are blikvm/blikvm. If you have changed the password for this user, you will need to update the corresponding username and password in the app.json file.
+
+```
+sudo -s
+vim /mnt/exec/release/config/app.json
+# Locate the following configuration and update it with your new credentials.
+"sshUser": "blikvm",
+"sshPassword": "blikvm"
+
+```
diff --git a/docs/zh/ssh.md b/docs/zh/ssh.md
@@ -0,0 +1,9 @@
+# SSH配置
+在1.4.7版本及以后，web支持直接进入blikvm的ssh终端，默认进入终端的账号密码为 blikvm/blikvm， 如果修改了此用户的密码信息，需要在app.json文件中修改对应的账号密码
+```
+sudo -s
+vim /mnt/exec/release/config/app.json
+// 找到下面配置，修改成你修改后的。
+"sshUser": "blikvm",
+"sshPassword": "blikvm"
+```
diff --git a/generated/en/404.html b/generated/en/404.html
@@ -596,6 +596,8 @@
 
 
 
+
+
 
 
 
@@ -767,6 +769,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/ssh/" class="md-nav__link">
+        SSH Terminal
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

diff --git a/generated/en/BLIHAT-Installation/index.html b/generated/en/BLIHAT-Installation/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>
@@ -568,7 +573,7 @@ <h2 id="2-install-the-main-device"><strong>2.</strong> Install the main device</
 </main>
 <footer class="md-footer">
 <nav aria-label="Footer" class="md-footer__inner md-grid">
-<a aria-label="Previous: Wake-on-LAN" class="md-footer__link md-footer__link--prev" href="../wake-on-lan/" rel="prev">
+<a aria-label="Previous: SSH Terminal" class="md-footer__link md-footer__link--prev" href="../ssh/" rel="prev">
 <div class="md-footer__button md-icon">
 <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"></path></svg>
 </div>
@@ -577,7 +582,7 @@ <h2 id="2-install-the-main-device"><strong>2.</strong> Install the main device</
 <span class="md-footer__direction">
                 Previous
               </span>
-              Wake-on-LAN
+              SSH Terminal
             </div>
 </div>
 </a>

diff --git a/generated/en/BLIKVM-CM4-guide/index.html b/generated/en/BLIKVM-CM4-guide/index.html
@@ -372,6 +372,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BLIKVM-HAT-guide/index.html b/generated/en/BLIKVM-HAT-guide/index.html
@@ -420,6 +420,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BLIKVM-PCIE-guide/index.html b/generated/en/BLIKVM-PCIE-guide/index.html
@@ -411,6 +411,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BLIKVM-PCIe-installation/index.html b/generated/en/BLIKVM-PCIe-installation/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BliKVM-v4-guide/index.html b/generated/en/BliKVM-v4-guide/index.html
@@ -377,6 +377,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/Datasheet-BliKVM-v4/index.html b/generated/en/Datasheet-BliKVM-v4/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/Dev-BliKVM-v4-Allwinner/index.html b/generated/en/Dev-BliKVM-v4-Allwinner/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/Expand_Filesystem/index.html b/generated/en/Expand_Filesystem/index.html
@@ -352,6 +352,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/OLED-display/index.html b/generated/en/OLED-display/index.html
@@ -342,6 +342,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/Product-Datasheet-BliKVM-v1-RPI-CM4/index.html b/generated/en/Product-Datasheet-BliKVM-v1-RPI-CM4/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/atx-guide/index.html b/generated/en/atx-guide/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/atx/index.html b/generated/en/atx/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/dev_api/index.html b/generated/en/dev_api/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/edid/index.html b/generated/en/edid/index.html
@@ -357,6 +357,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/faq/index.html b/generated/en/faq/index.html
@@ -372,6 +372,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/first_steps/index.html b/generated/en/first_steps/index.html
@@ -362,6 +362,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/flashing_os/index.html b/generated/en/flashing_os/index.html
@@ -380,6 +380,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/hdmi-csi-i2s/index.html b/generated/en/hdmi-csi-i2s/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/hid/index.html b/generated/en/hid/index.html
@@ -342,6 +342,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>
@@ -649,7 +654,7 @@ <h2 id="shortcuts"><strong>Shortcuts</strong></h2>
 <small>
 
       Last update:
-      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 15, 2024</span>
+      <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 19, 2024</span>
 <br/>
         Created:
         <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">May 7, 2023</span>

diff --git a/generated/en/https/index.html b/generated/en/https/index.html
@@ -325,6 +325,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/index.html b/generated/en/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/make-image/index.html b/generated/en/make-image/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/modify_pikvm_image/index.html b/generated/en/modify_pikvm_image/index.html
@@ -324,6 +324,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/msd/index.html b/generated/en/msd/index.html
@@ -347,6 +347,11 @@
         Wake-on-LAN
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../ssh/">
+        SSH Terminal
+      </a>
+</li>
 </ul>
 </nav>
 </li>