chore: add https guide

ThomasVon2021 · Sep 11, 2024 · 871846b · 871846b
1 parent 25aa684
commit 871846b
Show file tree

Hide file tree

Showing 87 changed files with 1,588 additions and 85 deletions.
diff --git a/config/en/mkdocs.yml b/config/en/mkdocs.yml
@@ -81,6 +81,7 @@ nav:
         - "ZeroTier VPN": zerotier.md
         - "Set Static IP ": static_ip.md
         - "Wifi Config": wifi.md
+        - "Encrypt certificates": https.md
     - "Function":
         - "Upgrade": update.md
         - "Keyboard": hid.md

diff --git a/config/zh/mkdocs.yml b/config/zh/mkdocs.yml
@@ -81,6 +81,7 @@ nav:
         - "Zerotier VPN": zerotier.md
         - "设置静态IP": static_ip.md
         - "Wifi配置": wifi.md
+        - "加密证书": https.md
     - "功能说明":
         - "更新软件": update.md
         - "视频&键鼠": hid.md

diff --git a/docs/en/https.md b/docs/en/https.md
@@ -0,0 +1,20 @@
+# Encryption Certificate
+
+Starting from version 1.4.4, BlikVM supports both HTTP and HTTPS modes. By default, it starts in HTTP mode. To start in HTTPS mode, modify the following configuration:
+
+```
+sudo -s
+vim /mnt/exec/release/config/app.json
+```
+
+Find the configuration below and change the protocol field from http to https, and change the port from 80 to 443. The key and cert are located in /mnt/exec/release/lib/https/, and users can replace them with their own.
+
+```
+"server": {
+    "protocol": "http",
+    "port":80,
+    "ssl": {
+    "key": "./lib/https/key.pem",
+    "cert": "./lib/https/cert.pem"
+}
+```
diff --git a/docs/zh/https.md b/docs/zh/https.md
@@ -0,0 +1,17 @@
+# 加密证书
+
+blikvm v1.4.4版本后,开始支持http和https两种模式, 默认以http形式启动，如果需要以https启动，需要修改以下配置:
+```
+sudo -s
+vim /mnt/exec/release/config/app.json
+```
+找到下面配置内容，将protocol字段对应http改为https，port端口由80改为443，其中key和cert在 /mnt/exec/release/lib/https/ 此路径，用户可以自己进行替换。
+```
+"server": {
+    "protocol": "http",
+    "port":80,
+    "ssl": {
+    "key": "./lib/https/key.pem",
+    "cert": "./lib/https/cert.pem"
+}
+```
diff --git a/generated/en/404.html b/generated/en/404.html
@@ -453,6 +453,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_2">
@@ -537,6 +539,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/https/" class="md-nav__link">
+        Encrypt certificates
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

diff --git a/generated/en/BLIHAT-Installation/index.html b/generated/en/BLIHAT-Installation/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BLIKVM-CM4-guide/index.html b/generated/en/BLIKVM-CM4-guide/index.html
@@ -297,6 +297,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BLIKVM-HAT-guide/index.html b/generated/en/BLIKVM-HAT-guide/index.html
@@ -345,6 +345,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BLIKVM-PCIE-guide/index.html b/generated/en/BLIKVM-PCIE-guide/index.html
@@ -336,6 +336,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BLIKVM-PCIe-installation/index.html b/generated/en/BLIKVM-PCIe-installation/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/BliKVM-v4-guide/index.html b/generated/en/BliKVM-v4-guide/index.html
@@ -302,6 +302,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/Datasheet-BliKVM-v4/index.html b/generated/en/Datasheet-BliKVM-v4/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </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
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/Expand_Filesystem/index.html b/generated/en/Expand_Filesystem/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/OLED-display/index.html b/generated/en/OLED-display/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </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
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/atx-guide/index.html b/generated/en/atx-guide/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/atx/index.html b/generated/en/atx/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/dev_api/index.html b/generated/en/dev_api/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/edid/index.html b/generated/en/edid/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/faq/index.html b/generated/en/faq/index.html
@@ -297,6 +297,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/first_steps/index.html b/generated/en/first_steps/index.html
@@ -287,6 +287,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/flashing_os/index.html b/generated/en/flashing_os/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/hdmi-csi-i2s/index.html b/generated/en/hdmi-csi-i2s/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>

diff --git a/generated/en/hid/index.html b/generated/en/hid/index.html
@@ -249,6 +249,11 @@
         Wifi Config
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../https/">
+        Encrypt certificates
+      </a>
+</li>
 </ul>
 </nav>
 </li>