More than 1 year has passed since last update.

ssh先で動くコンテナからx11アプリを動かす

Last updated at 2022-12-11Posted at 2022-12-08

X Window System についての説明は省きます。
間違っている箇所やご指摘等あれば仰っていただけると助かります
リモートホストと自宅PC間でssh接続している状況を想定します。
リモートホストはUbuntu20.04、自宅PCはWindows11です。
まず ssh先のリモートホスト（x11クライアント）と自宅PC（x11サーバ）間のx11通信 について、
その後 ssh先のリモートホスト上で動くコンテナ（x11クライアント）と自宅PC（x11サーバ）間のx11通信 について述べます。

ssh先のリモートホスト（x11クライアント）と自宅PC（x11サーバ）間のx11通信

まずssh先のリモートホスト（x11クライアント）と自宅PC（x11サーバ）でのx11アプリの実行についてです。
以下のように設定を行います。

ssh先のリモートホスト（x11クライアント）

/etc/ssh/sshd_config で以下の設定に変更します。

/etc/ssh/sshd_config

X11Forwarding yes

リモートホスト側で環境変数　DISPLAY　は自分でいじらなくて大丈夫だと思います。上記の設定に加え、次項で紹介するsshクライアント側でのx11転送を行う設定（sshの-Yオプションなど）を入れると、ssh接続時に自動で値が設定されると思います。

少し話はずれますが、wsl2（x11クライアント）とWindows（x11サーバ）という構成でx11通信を行う際は、wsl2側でDISPLAYの値に、WindowsのIPアドレスを設定をすることでx11通信を行うことができます。この際、WindowsのIPはipconfigなどで調べて設定してください。localhostと設定してはいけません、なぜならwsl2のlocalhostという意味になってしまうからです。あくまでx11サーバのIPアドレスを設定する必要があります。

しかしながらsshでx11通信を行う際はDISPlLAYの値が勝手にlocalhost:10.0とかに設定されると思いますが、これで問題なく通信できます。sshの場合は、sshを行った先のx11サーバのlocalhostという風に解釈してくれるのかな？って気がしてます。

↑ の説明間違っておりました
コメントで@ttdoda様が正しい解説をしてくださってるのでそちらを参考にしてください！
https://qiita.com/Atsuyaki_Tamago/items/64d9be136f09b3c49cdb#comment-51403eb193012f9895e0

自宅PC（x11サーバ）

sshでの設定と、x11のサーバアプリを起動するの2点を行う必要があります。

まずsshでの設定について、

調べるとsshする際に ssh -X　や ssh -YC などのオプションをつけるとよさそうです。
しかしながら powershell だとこのオプションをつけてもpowershell側のバグのためうまくx11転送が行うことができないようです（私もできませんでした、バージョンは　5.1.22621.436　です）。
そして コマンドプロンプト でもできませんでした。自分が何か間違ってるのかな？

↑ またまた間違っておりました
コメントで@ttdoda様が正しい解説をしてくださってるのでそちらを参考にしてください！
https://qiita.com/Atsuyaki_Tamago/items/64d9be136f09b3c49cdb#comment-51403eb193012f9895e0
使用するsshクライアントによって、sshクライアント側でDISPLAYの設定が必要かどうか変わってきそうです。

筆者はTeratermを用いてsshをし、teratermで以下のような設定を行うことで無事x11通信を行うことができました。（DISPLAYの値は設定せずに無事x11通信できました）

まずTeratermの設定からSSH転送を選択し、

「リモートのXアプリケーションをローカルのXサーバに表示する」にチェックを入れます。

これでsshでの設定は終了です。

次にx11のサーバアプリを起動するについてです。

いろいろあるかもしれませんが、筆者は VcXsrv を使いました。
「VcXsrv　インストール」などと調べれば記事が出てきますのでそちらを参考にしてください。

起動の方法についても割愛させていただきます。起動時のオプションで　Disable access control にチェックを入れることだけ忘れないでください。
これにて設定は終了です。

実行してみる

リモートホストにssh接続し、

リモートホスト

xeyes

xeyesを実行すると、自宅PCのディスプレイに

が表示されました！

ssh先のリモートホスト上で動くコンテナ（x11クライアント）と自宅PC（x11サーバ）間のx11通信

いよいよ本題です。
自宅PC側では先ほどと同じ設定で大丈夫です（VcXsrvを起動するのを忘れないでください！）

ssh先のリモートホスト

まずDockerイメージを作成します。あらかじめx11クライアントアプリをインストールしておきます。

リモートホスト:Dockerfile

# ubuntuのイメージを使用
FROM ubuntu:latest

# x11クライアントアプリをインストール
RUN apt-get update && apt-get install -y x11-apps

# コンテナはrootユーザで起動されるように設定
USER root

このイメージをbuildします。
tオプションをつけることによりイメージに名前をつけることができます。今回は「x11」と名付けました。

リモートホスト

sudo docker build ./ -t x11

それではコンテナを作成しbashを起動します（docker run でコンテナの作成からbashの起動まで以下のように一発でできます）。この際のオプションがポイントなのですが、このコマンドの下に説明を書いていきますね！

リモートホスト

sudo docker run   --rm   -it   --net=host   -e DISPLAY    -v $HOME/.Xauthority:/root/.Xauth_copy  x11 bash

--net=hostオプションによりコンテナがネットワーク名前空間をホストと共有します。おそらく共有しない場合はまた必要な設定が変わってくると思いますが今回は触れません（すみません）

-e DISPLAY によりホストのDISPLAY環境変数をコンテナに共有します。

-v $HOME/.Xauthority:/root/.Xauth_copy によりホストの $HOME/.Xauthority ファイルをコンテナの/root/に.Xauth_copyという仮の名前で共有します。ここがポイントでそのままコンテナの/root/に.Xauthorityという名前で共有してはいけません。
x11転送のためのx11認証が失敗してしまうからです（共有したファイルは所有者、所有グループが$HOME/.Xauthorityと同じなのに、コンテナのユーザーはrootだからかな？と思います。）。

それでは進めます。
今状態としてはbashを起動しコンテナの中に入っている状態です。
後は先ほど作成された/root/.Xauth_copyの所有者、所有グループをrootに、名前を/root/.Xauthorityに変更すればx11アプリが使えるようになるはずです！
ですが今は-v $HOME/.Xauthority:/root/.Xauth_copyにより /root/.Xauth_copyはvolume mount されている状態なので直接いじるべきではないです。なのでコピーします。

リモートホスト上のコンテナ