diff --git a/README.md b/README.md index accc7b2..e551659 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ NanoKVM Hardware -English | [中文](./README_ZH.md) +English | [中文](./README_ZH.md) | [日本語](./README_JA.md) diff --git a/README_JA.md b/README_JA.md new file mode 100644 index 0000000..ae30b66 --- /dev/null +++ b/README_JA.md @@ -0,0 +1,87 @@ +# NanoKVM + +
+ +![](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_3.jpg) + +

+ クイックスタート | + ハードウェア +

+ +[English](./README.md) | [中文](./README_ZH.md) | 日本語 + +
+ +> Your NanoKVM Power by RISC-V ! +> 使用中に問題や提案がある場合は、ここで issue を提出するか、[MaixHub Discussion](https://maixhub.com/discussion/nanokvm) でお知らせください。 + +## オープンソース & 貢献 & 出荷 + +スターが2Kに近づいています！10月中旬にバックエンドのソースコードを整理してオープンソース化します！（また、10.1前のすべての予約注文が出荷される時期でもあります） + +### 10.18 更新 + +10.8にバックエンドコードをオープンソース化しました。すぐにPRを提出してくれたCivilに感謝します。最新のNanoKVM-PCIeを報酬として提供します！ +10月中旬のバッチはテストとパッケージングを開始しており、10.1前のほとんどの注文は次週と次々週に出荷されます。 +10.1以降、アリエクスプレスの出荷日は12月に変更されました。これは保守的な納期です。10月の注文は11.15〜12.15の間に発送される予定です。 + +## 紹介 + +Lichee NanoKVMは、LicheeRV NanoをベースにしたIP-KVM製品で、LicheeRV Nanoの極小サイズと強力な機能を継承しています。 +Lichee NanoKVMは2つのバージョンがあります： +NanoKVM Liteは基本構成で、一定のDIY能力を持つ個人ユーザーや大量のニーズを持つ企業ユーザーに適しています。 +NanoKVM Fullは完全版で、洗練されたケースと完全なアクセサリーを備え、起動時にすぐに使用できるシステムミラーカードが内蔵されており、個人ユーザーに推奨されます。 + +![](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_1.jpg) + +## 技術仕様 + +| 製品 | NanoKVM (Lite) | NanoKVM (Full) | PiKVM V4 | +| --- | --- | --- | --- | +| 計算ユニット | LicheeRV Nano(RISCV) | LicheeRV Nano(RISCV) | CM4 (ARM) | +| 解像度 | 1080P @ 60fps | 1080P @ 60fps | 1080P @ 60fps | +| ビデオエンコーディング | MJPEG, H264(開発中) | MJPEG, H264(開発中) | MJPEG, H264 | +| ビデオ遅延 | 90～230ms | 90～230ms | 100～230ms | +| UEFI/BIOS | ✓ | ✓ | ✓ | +| 仮想HID | ✓ | ✓ | ✓ | +| 仮想CD-ROM | ✓ | ✓ | ✓ | +| IPMI | ✓ | ✓ | ✓ | +| Wake-on-LAN | ✓ | ✓ | ✓ | +| ETH | 100M/10M | 100M/10M | 1000M/100M/10M | +| ATX電源制御 | なし、ユーザーが自分で接続 | USBインターフェースIO制御ボード | RJ-45インターフェースIO制御ボード | +| OLED | なし、ユーザーが自分で接続 | 128x64 0.96" 白 | 128x32 0.91" 白 | +| UART | 2 | 2 | 1 | +| TFカード | なし | ✓ | ✓ | +| 拡張 | なし | PoE | WiFi/LTE | +| 消費電力 | 0.2A@5V | 0.2A@5V | ピーク2.6A@5V | +| 電源入力 | PC USBで給電可能 | PC USBまたは補助電源 | DC 5V 3A電源が必要 | +| 冷却 | 静音ファンレス | 静音ファンレス | ファン冷却 | +| サイズ | 23x37x15mm
～1/30 PiKVM V4サイズ | 40x36x36mm
～1/7 PiKVM V4サイズ | 120x68x44mm | + +![](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_2.jpg) + +## ハードウェアプラットフォーム NanoKVM + +NanoKVMはSipeed [LicheeRV Nano](https://wiki.sipeed.com/hardware/zh/lichee/RV_Nano/1_intro.html)に基づいており、仕様、回路図、寸法図は[こちら](http://cn.dl.sipeed.com/shareURL/LICHEE/LicheeRV_Nano)で確認できます。 + +NanoKVM LiteはLicheeRV NanoとHDMItoCSIボードで構成され、NanoKVM FULLはNanoKVM LiteにNanoKVM-A/Bボードとシェルを追加しています。HDMItoCSIボードはHDMI信号を変換するために使用されます。NanoKVM-AにはOLED、ATX制御出力（USB Type-Cインターフェース）、補助電源供給およびATX電源オン/オフおよびリセットボタンが含まれています。NanoKVM-Bは一端がAボードに接続され、他端がコンピュータのATXピンに接続され、コンピュータの電源をリモートで制御します。 + +NanoKVMイメージはLicheeRV Nano SDKおよびMaixCDKに基づいて構築されており、LicheeRV Nanoを使用する資料と互換性があります。逆に、KVMソフトウェアはLicheeRV Nanoや他のSG2002製品では使用できません。LicheeRV NanoやMaixCamでHDMI入力アプリケーションを構築したい場合は、技術サポートを受けるためにお問い合わせください。 + +注：SG2002の256MBメモリのうち、現在105MBがマルチメディアサブシステムに割り当てられており、NanoKVMはビデオ画像の取得と処理にこのメモリを使用します。 + ++ [NanoKVM-A 回路図](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_RV_Nano_KVM_A_30111.pdf) ++ [NanoKVM-B 回路図](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_HDMI_MIPI_31011.pdf) ++ [NanoKVM イメージダウンロード](https://github.com/sipeed/NanoKVM/releases/tag/NanoKVM) + +## 購入方法 + +* [Aliexpress(グローバル、米国とロシアを除く)](https://www.aliexpress.com/item/1005007369816019.html) +* [淘宝](https://item.taobao.com/item.htm?id=811206560480) +* [予約注文 (淘宝とアリエクスプレスがサポートされていない国)](https://sipeed.com/nanokvm) + +## コミュニティ + +* [MaixHub Discussion](https://maixhub.com/discussion/nanokvm) +* QQグループ: 703230713 diff --git a/README_ZH.md b/README_ZH.md index 36be1d4..7c912c4 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -10,7 +10,7 @@ NanoKVM 硬件资料 -[English](./README.md) | 中文 +[English](./README.md) | 中文 | [日本語](./README_JA.md) @@ -78,6 +78,3 @@ NanoKVM 镜像在LicheeRV Nano SDK 和 MaixCDK 基础上构建，可以兼容使 * [MaixHub Discussion](https://maixhub.com/discussion/nanokvm) * QQ group: 703230713 - - - diff --git a/server/README_JA.md b/server/README_JA.md new file mode 100644 index 0000000..86fe529 --- /dev/null +++ b/server/README_JA.md @@ -0,0 +1,75 @@ +# NanoKVM サーバー + +これは NanoKVM のバックエンドサーバーの実装です。 + +詳細なドキュメントについては、[Wiki](https://wiki.sipeed.com/nanokvm) を参照してください。 + +## 構造 + +```shell +server +├── common // 共通ユーティリティコンポーネント +├── config // サーバー設定 +├── dl_lib // 共有オブジェクトライブラリ +├── include // 共有オブジェクトのヘッダーファイル +├── logger // ロギングシステム +├── middleware // サーバーミドルウェアコンポーネント +├── proto // API リクエスト/レスポンス定義 +├── router // API ルートハンドラ +├── service // コアサービスの実�� +├── utils // ユーティリティ関数 +└── main.go +``` + +## 設定 + +設定ファイルのパスは `/etc/kvm/server.yaml` です。 + +```yaml +proto: http +port: + http: 80 + https: 443 +cert: + crt: server.crt + key: server.key + +# ログレベル (debug/info/warn/error) +# 注意: 本番環境では 'info' または 'error' を使用し、'debug' は開発環境でのみ使用してください +logger: + level: info + file: stdout + +# 認証設定 (enable/disable) +# 注意: 認証を無効にするのは開発環境でのみ行ってください +authentication: enable + +# JWT 秘密鍵の設定 +# 空のままにすると、サーバー起動時にランダムな鍵が生成されます +secretKey: "" +``` + +## コンパイルとデプロイ + +注意: Linux オペレーティングシステム (x86-64) を使用してください。このビルドプロセスは ARM、Windows、macOS では互換性がありません。 + +1. ツールチェーンのインストール + 1. 以下のリンクからツールチェーンをダウンロードします: [ダウンロードリンク](https://sophon-file.sophon.cn/sophon-prod-s3/drive/23/03/07/16/host-tools.tar.gz)。 + 2. ファイルを解凍し、`host-tools/gcc/riscv64-linux-musl-x86_64/bin` ディレクトリを PATH 環境変数に追加します。 + 3. `riscv64-unknown-linux-musl-gcc -v` を実行します。バージョン情報が表示されれば、インストールは成功です。 + +2. プロジェクトのコンパイル + 1. プロジェクトのルートディレクトリから `cd server` を実行します。 + 2. `go mod tidy` を実行して Go の依存関係をインストールします。 + 3. `CGO_ENABLED=1 GOOS=linux GOARCH=riscv64 CC=riscv64-unknown-linux-musl-gcc CGO_CFLAGS="-mcpu=c906fdv -march=rv64imafdcv0p7xthead -mcmodel=medany -mabi=lp64d" go build` を実行してプロジェクトをコンパイルします。 + 4. コンパイルが完了すると、`NanoKVM-Server` という名前の実行ファイルが生成されます。 + +3. RPATH の変更 + 1. `sudo apt install patchelf` または `pip install patchelf` を実行して patchelf をインストールします。 + 2. `patchelf --version` を実行します。バージョンが 0.14 以上であることを確認します。 + 3. `patchelf --add-rpath \$ORIGIN/dl_lib NanoKVM-Server` を実行して、実行ファイルの RPATH を変更します。 + +4. アプリケーションのデプロイ + 1. デプロイ前に、ブラウザでアプリケーションを最新バージョンに更新します。手順は[こちら](https://wiki.sipeed.com/hardware/en/kvm/NanoKVM/system/updating.html)を参照してください。 + 2. コンパイルして生成された `NanoKVM-Server` ファイルを使用して、NanoKVM の `/kvmapp/server/` ディレクトリ内の元のファイルを置き換えます。 + 3. NanoKVM で `/etc/init.d/S95nanokvm restart` を実行してサービスを再起動します。 diff --git a/web/README_JA.md b/web/README_JA.md new file mode 100644 index 0000000..44aa2be --- /dev/null +++ b/web/README_JA.md @@ -0,0 +1,58 @@ +# NanoKVM フロントエンド + +これは NanoKVM のウェブプロジェクトです。詳細なドキュメントについては、[Wiki](https://wiki.sipeed.com/nanokvm) を参照してください。 + +## 構造 + +```shell +src +├── api // バックエンド API +├── assets // 静的リソース +├── components // 公共コンポーネント +├── i18n // 言語リソース +├── jotai // グローバル jotai 変数 +├── lib // ユーティリティライブラリ +├── pages // ウェブページ +│ ├── auth // ログインとパスワード +│ ├── desktop // リモートデスクトップ +│ └── terminal // ウェブターミナル +├── router.tsx // ルーター +└── types // 型定義 +``` + +## ローカル開発 + +CORS 制限のため、ローカル開発中は認証を無効にする必要があります。 + +認証機能を開発するには、プロジェクトをビルドして NanoKVM でテストする必要があります。 + +1. SSH を介して NanoKVM にログインします：`ssh root@your-nanokvm-ip`（デフォルトのパスワードは root です）。 +2. 設定ファイル `/etc/kvm/server.yaml/` を開き、`authentication: disable` を追加します。⚠️注意：このオプションはすべての認証を無効にし、本番環境では有効にしないでください！ +3. サービスを再起動します：`/etc/init.d/S95nanokvm restart`。 +4. `.env.development` ファイルを編集し、`VITE_SERVER_IP` を NanoKVM の IP アドレスに変更します。 +5. `pnpm dev` を実行してサーバーを起動し、ブラウザで http://localhost:3001/ にアクセスします。 + + +開発中のアクセス問題を避けるため、ブラウザのキャッシュを無効にすることをお勧めします： + +1. ブラウザの開発者ツールを開きます； +2. `Network` タブに移動します； +3. `Disable cache` オプションをチェックします； +4. ページをリフレッシュします。 + +## デプロイ + +ビルド： + +```shell +cd web +pnpm install +pnpm build +``` + +1. コンパイルが完了すると、`dist` フォルダが生成されます。 +2. フォルダの名前を `web` に変更します。 +3. `web` を NanoKVM の `/kvmapp/server/` にアップロードします。 +4. NanoKVM で `/etc/init.d/S95nanokvm restart` を実行してサービスを再起動します。 + +また、ブラウザに古いバージョンのキャッシュが残っている可能性があります。ページが開かない場合は、強制リフレッシュまたはキャッシュのクリアを試してください。