From e3678d913e8d62d855599037f324d031b01e2bc6 Mon Sep 17 00:00:00 2001 From: fa0311 Date: Mon, 30 May 2022 03:50:16 +0900 Subject: [PATCH] add Japanese translation --- content/self-host/client/_index.ja.md | 4 +- content/self-host/install/_index.ja.md | 131 ++++++++++++++++++++++++- content/self-host/synogy/_index.ja.md | 66 ++++++++++++- content/self-host/windows/_index.ja.md | 28 +++++- 4 files changed, 224 insertions(+), 5 deletions(-) diff --git a/content/self-host/client/_index.ja.md b/content/self-host/client/_index.ja.md index a9dd4ef..81e17b1 100644 --- a/content/self-host/client/_index.ja.md +++ b/content/self-host/client/_index.ja.md @@ -1,6 +1,6 @@ --- -title: Client-Side Settings +title: クライアント側の設定 weight: 40 --- -[English](/docs/en/self-host/client) \ No newline at end of file +[クライアント側で hbbs/hbbr のアドレスを設定する](/docs/en/self-host/install/#step-3--set-hbbshbbr-address-on-client-side) \ No newline at end of file diff --git a/content/self-host/install/_index.ja.md b/content/self-host/install/_index.ja.md index c5aca04..1982103 100644 --- a/content/self-host/install/_index.ja.md +++ b/content/self-host/install/_index.ja.md @@ -3,4 +3,133 @@ title: インストール weight: 10 --- -[English](/docs/en/self-host/install) \ No newline at end of file +## 簡単に自分専用のサーバーを構築できます +----------- + +### STEP-1 : サーバーサイドソフトウェアのダウンロード + +[ダウンロード](https://github.com/rustdesk/rustdesk-server/) もしくはDocker [rustdesk/rustdesk-server](https://hub.docker.com/r/rustdesk/rustdesk-server/tags) からダウンロードします。 + +対応するプラットフォーム: + - Linux + - Windows + +このドキュメントではLinux用ビルドを使用して構築します。 + +ビルドには2つの実行ファイルとフォルダがあります: + - hbbs - RustDesk ID/Rendezvous サーバー + - hbbr - RustDesk リレーサーバー + +Centos7 でビルドされ Centos7/8, Ubuntu18/20 で動作確認されています。 + +#### サーバーの要件 +ハードウェアの要件は非常に低くクラウドサーバーの最小構成で十分でありCPUとメモリは必要最低限で済みます。ネットワーク帯域については、TCPホールパンチングへのダイレクト接続に失敗した場合に中継トラフィックを使用します。中継トラフィックは解像度設定や画面更新速度にもよりますが 30K-3M/s (1920x1080画面) ほどです。 オフィスワーク需要のみであれば、100K/s程度のトラフィックになります。 + + +### STEP-2 : サーバ上でhbbsとhbbrを実行します + +あなたのサーバー (Centos または Ubuntu) でhbbs/hbbrを実行します。[pm2](https://pm2.keymetrics.io/) を使用してサービスを管理することを推奨します。 + +``` +./hbbs -r +./hbbr +``` + +もしくは hbbs/hbbr を pm2 を使用して実行します + +``` +pm2 start hbbs -- -r +pm2 start hbbr +``` + + +{{% notice note %}} +pm2 を動作させるには nodejs v16+ が必要です。pm2 を実行できない場合 (例えば `pm2 list` に hbbs/hbbr が表示されない時) はLTS版の node.js を https://nodejs.org からダウンロードしインストールしてください。もし hbbs/hbbr を再起動後に自動実行させたいなら `pm2 save` と `pm2 startup` を確認してみてください。 詳しくは [pm2](https://pm2.keymetrics.io/docs/usage/quick-start/) から確認できます。 ログを記録するのは [pm2-logrotate](https://github.com/keymetrics/pm2-logrotate) を使うのがオススメです。 + +hhbsの `-r` パラメータは必須ではなくサーバー側で指定するとクライアント側で中継サーバを指定せず済むので便利です。またデフォルトの 21117 ポートを使う場合はポートを指定する必要はありません。クライアント側が指定するリレーサーバーはこれよりも優先度が高いです。 **RustDeskコントロールクライアント 1.1.9 以降では中継サーバーが別のホストやポートで動作していない場合、クライアント側でも中継サーバーのアドレスを指定する必要はありません。** +{{% /notice %}} + +デフォルトでは hbbs は 21115(tcp) と 21116(tcp/udp) と 21118(tcp) を使用し hbbr は 21117(tcp) と 21119(tcp) を使用します。ファイアウォールでこれらのポートを必ず開放してください。**21116はTCPとUDPの両方で開放する必要があることに注意してください。** 21115 はNATタイプの確認、21116/UDP はTCPホールパンチング,コネクションサービス、21117はリレーサービス、21118 と 21119 はWebクライアントのサポートに使用します。ウェブクライアント(21118, 21119) のサポートが不要な場合は該当するポートを無効にしても良いです。 + +- TCP(**21115, 21116, 21117, 21118, 21119**) +- UDP(**21116**) + +また "-h" オプションをつけて実行するとヘルプが表示されますのでお好みのポートを指定してください。 + +#### Dockerの例 + +##### Linux/amd64 +``` +sudo docker image pull rustdesk/rustdesk-server +sudo docker run --name hbbs -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v `pwd`:/root -it --net=host --rm rustdesk/rustdesk-server hbbs -r +sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --net=host --rm rustdesk/rustdesk-server hbbr +``` + +##### Linux/arm64v8 +``` +sudo docker image pull rustdesk/rustdesk-server:latest-arm64v8 +sudo docker run --name hbbs -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v `pwd`:/root -it --net=host --rm rustdesk/rustdesk-server:latest-arm64v8 hbbs -r +sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --net=host --rm rustdesk/rustdesk-server:latest-arm64v8 hbbr +``` + + + +{{% notice note %}} +--net=host は私の知る限り Linux のみで動作し hbbs/hbbr はコンテナのip (172.17.0.1) ではなく実際の接続ipを参照します +もし --net=host がうまく動けば -p オプションは使用しません。 + +**お使いのプラットフォームで接続に問題がある場合は --net=host を削除してください** +{{% /notice %}} + + +### STEP-3 : クライアント側でhbbs/hbbrのアドレスを設定する + +IDの右側にあるメニューボタンをクリックし "ID/Relay Server" を選択します。 + +![](/docs/en/self-host/install/images/server-set-menu.png) + +IDサーバ入力欄にhbbsのホストまたはipアドレスを入力します（ローカル側＋リモート側）他の2つのアドレスは空白でも構いません。特に設定しない場合はRustDeskが自動的に入力します。中継サーバーはhbbr (21116ポート) を参照します。 + +例: + +``` +hbbs.example.com +``` + +または + +``` +hbbs.example.com:21116 +``` + +![](/docs/en/self-host/install/images/server-set-window.png) + +#### rustdesk.exe のファイル名を変更して設定する (Windowsのみ) + +`rustdesk.exe` を rustdesk-`host=,key=`.exe に変更します。例: rustdesk-`host=192.168.1.137,key=xfdsfsd32=32`.exe 設定情報は about ウィンドウに以下のように表示されます。 + +{{% notice note %}} +`host` と `key` の両方を設定する必要がありどちらか片方でも欠けていると動作しません。 +{{% /notice %}} + +| メニュー | About ページ | +| -- | -- | +![](/docs/en/self-host/install/images/aboutmenu.png) | ![](/docs/en/self-host/install/images/lic.png) | + +## 鍵 +----------- +古いバージョンとは異なりこのバージョンでは鍵が必須ですが自分で設定する必要はありません。hbbs が初めて起動された時に暗号化された秘密鍵と公開鍵のペアが自動的に生成されます (それぞれ実行ディレクトリの `id_ed25519` と `id_ed25519.pub` ファイルにあります) + +前のステップで `Key:` (公開鍵ファイル `id_ed25519.pub` の内容) を記入しなかった場合接続には影響しませんが接続は暗号化されません。 + +```` +cat ./id_ed25519.pub +```` + +もし鍵のないユーザが暗号化されていない接続を確立することを禁止したい場合は、hbbs と hbbr を実行する際に `-k _` パラメータを追加してください。 +```` +./hbbs -r -k _ +./hbbr -k _ +```` + +鍵を変更したい場合は `id_ed25519` と `id_ed25519.pub` を削除し hbbs/hbbr を再起動すると新しい鍵ペアが生成されます。 \ No newline at end of file diff --git a/content/self-host/synogy/_index.ja.md b/content/self-host/synogy/_index.ja.md index 0253f97..9810049 100644 --- a/content/self-host/synogy/_index.ja.md +++ b/content/self-host/synogy/_index.ja.md @@ -3,4 +3,68 @@ title: Synology weight: 22 --- -[English](/docs/en/self-host/synogy) \ No newline at end of file +このチュートリアルは最新のDSM v6を使用しています。 + +### Docker のインストール + +パッケージマネージャを開き、dockerをインストールします + +| | | +| --------------- | -------------------------------------------------------- | +![](/docs/en/self-host/synogy/images/package-manager.png) | ![](/docs/en/self-host/synogy/images/docker.png) + + +### RustDeskサーバーのインストール + +| Dockerのレジストリからrustdesk-serverを検索しダブルクリックでインストールします | rustdesk-server イメージをインストールしダブルクリックで rustdesk-server コンテナを作成します | +| --------------- | -------------------------------------------------------- | +![](/docs/en/self-host/synogy/images/pull-rustdesk-server.png) | ![](/docs/en/self-host/synogy/images/rustdesk-server-installed.png) + + +### hbbsコンテナの作成 + +上記のように rustdesk-server イメージをダブルクリックして新しいコンテナを作成し名前を `hbbs` にします。 +![](/docs/en/self-host/synogy/images/hbbs.png) + +"Advanced Settings" をクリックします。 + +- 自動再起動を有効にする +![](/docs/en/self-host/synogy/images/auto-restart.png) + +- "Use the same network as Docker host" を有効にします。 ホストの詳細については [こちら](/docs/en/self-host/install/#net-host) を確認してください +![](/docs/en/self-host/synogy/images/host-net.png) + +- コンテナ内のホームディレクトリ `/root` をホストディレクトリ (例: `Shared/test/`) に配置するとhbbsはこのディレクトリにいくつかのファイル (`鍵`ファイルを含む) を生成します +| 配置 | ホームディレクトリに生成されるファイル | +|-- | -- | +![](/docs/en/self-host/synogy/images/mount.png?width=500px) | ![](/docs/en/self-host/synogy/images/mounted-dir.png?width=300px) + +- コマンドの設定 +{{% notice note %}} +Synogy の OS は debain ベースなのでホストネット (--net=host) は問題なく動作するので `-p` オプションでポートをマッピングする必要はありません。 + +`192.168.16.98` はプライベートネットワークのIPでここではデモのために使用しています。デプロイ時にはパブリックIPに設定してください。 + +{{% /notice %}} + +![](/docs/en/self-host/synogy/images/hbbs-cmd.png?v2) + +- 完了 + +![](/docs/en/self-host/synogy/images/hbbs-config.png) + +### hbbr コンテナの作成 + +上記の `hbbs` の手順を繰り返してください。ただしコンテナ名を `hbbr` にコマンドを `hbbr` に変更してください。 + +![](/docs/en/self-host/synogy/images/hbbr-config.png) + +### hbbr/hbbs コンテナ + +![](/docs/en/self-host/synogy/images/containers.png?width=500px) + + +| コンテナをダブルクリックしログを確認する | ホストネットワークを使用したhbbs/hbbrの二重確認 | +|-- | -- | +![](/docs/en/self-host/synogy/images/log.png?width=500px) | ![](/docs/en/self-host/synogy/images/network-types.png?width=500px) + diff --git a/content/self-host/windows/_index.ja.md b/content/self-host/windows/_index.ja.md index 2ebfd88..4d58bb7 100644 --- a/content/self-host/windows/_index.ja.md +++ b/content/self-host/windows/_index.ja.md @@ -3,4 +3,30 @@ title: Windows & pm2 weight: 20 --- -[English](/docs/en/self-host/windows) \ No newline at end of file + +### NodeJs をインストール +[ダウンロード](https://nodejs.org/dist/v16.14.2/node-v16.14.2-x86.msi) してインストールしてください。 +NodeJs は pm2 の実行環境ですので先にNodeJsをインストールする必要があります。 + +### pm2 をインストール +cmd.exe に下記を入力し1行ごとにEnterキーを押して1行ずつ実行します。 +``` +npm install -g pm2 +npm install pm2-windows-startup -g +pm2-startup install +``` + +### hbbr と hbbs を実行 +Windows版のサーバープログラムをダウンロードします。Cドライブに解凍するのであれば以下の4行のコマンドをそれぞれ実行します。 +``` +cd c:\rustdesk-server-windows-x64 +pm2 start hbbs.exe -- -r +pm2 start hbbr.exe +pm2 save +``` + +### ログを確認 +``` +pm2 log hbbr +pm2 log hbbs +``` \ No newline at end of file