Skip to content

Commit

Permalink
chore: update some guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasVon2021 committed Sep 23, 2024
1 parent f2d07d1 commit 57dc012
Show file tree
Hide file tree
Showing 105 changed files with 96 additions and 1,648 deletions.
1 change: 0 additions & 1 deletion config/en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ nav:
- "Serial-over-USB": serial_over_usb.md
- "MSD": msd.md
- "HDMI EDID": edid.md
- "User Manager": user-manager.md
- "Wake-on-LAN": wake-on-lan.md
- "SSH Terminal": ssh.md
- "Installation Instructions":
Expand Down
1 change: 0 additions & 1 deletion config/zh/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ nav:
- "U盘驱动": msd.md
- "串口终端": serial_over_usb.md
- "HDMI EDID设置": edid.md
- "修改账号密码": user-manager.md
- "Wake-on-LAN": wake-on-lan.md
- "SSH终端": ssh.md
- "安装说明":
Expand Down
9 changes: 3 additions & 6 deletions docs/en/port-forwarding.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# **Port forwarding**

If your ISP provides an external IP address for the router, you can configure Port forwarding to access BliKVM:

* The web interface uses the HTTP protocol and occupies port 80;
* If your hardware is v1 v2 v3 and you are using web rtc transmission, the port is 8188;
* If your hardware is v4 and you are using mjepg transmission, the port is 8008;
* Note that the port does not support modification and can only be configured for forwarding;
After v1.4.7 version If your ISP provides an external IP address for the router, you can configure Port forwarding to access BliKVM:

* If the web interface uses the HTTP protocol and occupies port 80;
* If the web interface uses the HTTPS protocol and occupies port 443;
If you do not have an external IP address, we suggest trying to use [Tailscale VPN](./tailscale.md)
10 changes: 0 additions & 10 deletions docs/en/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,3 @@
python3 install_release.py --releasepath=./
```
You can compare the versions before and after in `/usr/bin/blikvm/package.json`. If you have upgraded to the specified version, the installation is successful, and you can reboot for the changes to take effect.

## **Web UI Update**

!!! warning "The current web upgrade function is temporarily disabled. Please use the command line to update"

!!! info "After clicking the More Options button, find the Check Update button and click it. If the available version is found, the pop-up box in the figure below will appear. Click OK to enter the upgrade process. The web interface is temporarily inoperable during the upgrade process. View the current update status by manually refreshing the page. When the message of successful update appears, it means that the update has been successful. Click the restart button, and the new version of software will take effect."
![IMG_8366](assets/images/update/update_button.png){width="300"}
![IMG_8366](assets/images/update/update_info.png){width="300"}
![IMG_8366](assets/images/update/upgrading.png){width="300"}
![IMG_8366](assets/images/update/update_reboot.png){width="300"}
8 changes: 0 additions & 8 deletions docs/en/user-manager.md

This file was deleted.

7 changes: 2 additions & 5 deletions docs/zh/port-forwarding.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# **端口转发**

如果您的ISP为路由器提供了外部IP地址,您可以配置端口转发以访问BliKVM。
在v1.4.7版本后,如果您的ISP为路由器提供了外部IP地址,您可以配置端口转发以访问BliKVM。

* Web界面为http协议,占用的是80端口;
* 如果您的硬件是V1 V2 V3,使用的是是web-rtc传输,端口是8188;
* 如果您的硬件是V4,使用的是mjepg传输,端口是8008;
* 注意端口不支持被修改,只能配置转发;
* Web如果选择为http协议,占用的是80端口,如果选择的为https协议占用的是443;

如果您没有外部IP地址,我们建议尝试使用[Tailscale VPN](./tailscale.md)
8 changes: 0 additions & 8 deletions docs/zh/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,6 @@
python3 install_release.py --releasepath=./
```
可以观察/usr/bin/blikvm/package.json前后的版本对比,若升级到了指定版本,则成功,重启生效。

## **Web界面更新**
!!! warning "当前web升级功能暂时关闭,请使用命令行更新"
!!! info "点击更多选项按钮后,找到**检查更新**按钮并点击,若发现可用版本,会出现下图中的弹框,点击**OK**,即进入升级,升级过程中web界面暂时不可操作。通过手动刷新页面,查看目前更新状态。当出现更新成功的消息提醒时,即表示更新已成功,点击重启按钮,新版本软件就会生效。"
![IMG_8366](assets/images/update/update_button.png){width="300"}
![IMG_8366](assets/images/update/update_info.png){width="300"}
![IMG_8366](assets/images/update/upgrading.png){width="300"}
![IMG_8366](assets/images/update/update_reboot.png){width="300"}



Expand Down
5 changes: 0 additions & 5 deletions docs/zh/user-manager.md

This file was deleted.

16 changes: 0 additions & 16 deletions generated/en/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -596,8 +596,6 @@








Expand Down Expand Up @@ -746,20 +744,6 @@



<li class="md-nav__item">
<a href="/user-manager/" class="md-nav__link">
User Manager
</a>
</li>









<li class="md-nav__item">
<a href="/wake-on-lan/" class="md-nav__link">
Wake-on-LAN
Expand Down
5 changes: 0 additions & 5 deletions generated/en/BLIHAT-Installation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/BLIKVM-CM4-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -363,11 +363,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/BLIKVM-HAT-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,11 +411,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/BLIKVM-PCIE-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -402,11 +402,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/BLIKVM-PCIe-installation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/BliKVM-v4-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -368,11 +368,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/Datasheet-BliKVM-v4/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/Dev-BliKVM-v4-Allwinner/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/Expand_Filesystem/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -343,11 +343,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/OLED-display/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -333,11 +333,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/Product-Datasheet-BliKVM-v1-RPI-CM4/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
Binary file removed generated/en/assets/images/update/update_button.png
Binary file not shown.
Binary file removed generated/en/assets/images/update/update_info.png
Binary file not shown.
Binary file removed generated/en/assets/images/update/update_reboot.png
Binary file not shown.
Binary file removed generated/en/assets/images/update/upgrading.png
Binary file not shown.
5 changes: 0 additions & 5 deletions generated/en/atx-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/atx/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/dev_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
9 changes: 2 additions & 7 deletions generated/en/edid/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -348,11 +348,6 @@
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down Expand Up @@ -618,13 +613,13 @@ <h2 id="custom-edid">Custom EDID</h2>
</div>
</div>
</a>
<a aria-label="Next: User Manager" class="md-footer__link md-footer__link--next" href="../user-manager/" rel="next">
<a aria-label="Next: Wake-on-LAN" class="md-footer__link md-footer__link--next" href="../wake-on-lan/" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
User Manager
Wake-on-LAN
</div>
</div>
<div class="md-footer__button md-icon">
Expand Down
5 changes: 0 additions & 5 deletions generated/en/faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -363,11 +363,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/first_steps/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -353,11 +353,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/flashing_os/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -371,11 +371,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/hdmi-csi-i2s/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/hid/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -333,11 +333,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/https/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -316,11 +316,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
5 changes: 0 additions & 5 deletions generated/en/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,6 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="user-manager/">
User Manager
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="wake-on-lan/">
Wake-on-LAN
</a>
Expand Down
Loading

0 comments on commit 57dc012

Please sign in to comment.