[Linux] X11 포워딩하기 (Ubuntu xserver, Window VcXsrv, MacOS XQuartz): 서버/도커에서 QUI 확인하기

💡 본 문서는 '[Linux] X11 포워딩하기 (Ubuntu, MacOS XQuartz): 서버/도커에서 QUI 확인하기)'에 대해 정리해놓은 글입니다.
Ubuntu 서버나 docker 컨테이너에서 GUI 프로그램을 실행시킬 경우, X11 forwarding을 통해 해당 host에서 띄울 수 있도록 설정해주는 과정이 필요한데 해당 내용에 대해 정리하였으니 참고하시기 바랍니다.

1. X11 포워딩

1.1. X11 포워딩이란?

별도로 있는 리눅스 PC에 ssh 접속으로 콘솔 작업은 가능한데 GUI 프로그램은 실행 할 수가 없습니다. 이때 GUI 화면을 포워딩해서 맥에서 그 화면과 조작을 가능하게 할려면 X11 포워딩을 하면 됩니다.

저는 메인으로 macOS를 사용해서 macOS에서 사용 할 수 있는 방법을 알아 보겠습니다 . 아래 링크를 참조 하였으며 아래 링크에서는 macOS 뿐만이 아니고 윈도우와 리눅스에서 사용하는 방법도 있으니 참고 하시면 됩니다.

• [blog] How to Set Up and Use X11 Forwarding on Linux and Mac: https://www.businessnewsdaily.com/11035-how-to-use-x11-forwarding.html

1.2. X11 환경 설정

X11 환경 설정 (in Window)

VcXsrv Windows X Server Download: https://sourceforge.net/projects/vcxsrv/files/latest/download

X11 환경 설정 (in Ubuntu)

$ sudo apt-get update
$ sudo apt-get -y install xorg xrdp xserver-xorg mesa-utils xauth gdm3

$ xhost +local:root

X11 환경 설정 (in MacOS)

macOS에서는 XQuartz라는 프로그램을 설치하면 됩니다. 프로그램 홈페이지에서 설치 파일을 다운로드 할 수도 있지만 brew를 통해서도 설치를 할 수 있습니다.

% brew install --cask xquartz

다시 로그인하거나 재부팅하면 Mac에서 기본 X11 server로 XQuartx가 활성화되어 X11 포워딩이 가능합니다. 이후 XQuartz의 설정을 열어 Security(보안) 탭에서 "Allow connections from network clients(네트워크 클라이언트에서의 연결을 허용)"를 클릭하여 클라이언트 접속이 가능하도록 합니다.

추가로 xhost 설정을 해주면 기본적인 설정이 끝납니다.

% nano ~/.bashrc
...
xhost + <Server IP>

% source ~/.bashrc

2. X11 포워딩

2.1. ubuntu 서버 접속

2.1.1. Shell 스크립트 활용

ssh로 접속시 -X 옵션을 주면 X11 포워딩이 가능합니다.

% ssh -X sjchoi@192.168.0.1

이후 x11-apps에 내장되어 있는 GUI 프로그램(xeyes)을 실행해 보면 정상적으로 표시가 됩니다.

sjchoi@sjchoi-desktop$ xeyes

​2.1.2. VSCode 활용

vscode extension에서 'Remote-SSH'를 설치하여 vscode에서 원격으로 작업할 수 있도록 만듭니다.

ssh 설정 관리하는 파일인 ~/.ssh/config 를 다음과 같이 ForwardX11, ForwardX11Trusted를 yes로 추가합니다.

Host 192.168.0.1
  HostName 192.168.0.1
  User sjchoi
  ForwardX11 yes
  ForwardX11Trusted yes

2.2. docker 컨테이너 접속

2.2.1. docker-compose.yml 활용

참고: https://github.com/DrawingProcess/ros2-gazebo-docker-arm64

version: "3.8"

services:
  ros2:
    build:
      context: docker/ros2
      args:
        - user_id=1000
        - ros_ws=/home/dockeruser/dev_ws

    # Enabling GPU access with Compose
    # https://docs.docker.com/compose/gpu-support/
    # deploy:
    #   resources:
    #     reservations:
    #       devices:
    #          - capabilities: [gpu]
    #            count: all

    environment:
      # Set a fancy prompt (See ~/.bashrc in the container)
      - TERM=xterm-256color

      # Mac X11
      - DISPLAY=192.168.35.143:0

    volumes:
      - ./:/home/dockeruser/project
      - ./dev_ws:/home/dockeruser/dev_ws
      - ./docker/ros2/.ros:/home/dockeruser/.ros
      - ./docker/ros2/.gazebo/:/home/dockeruser/.gazebo

      # Mac X11
      - /tmp/.X11-unix:/tmp/.X11-unix
      - ~/.Xauthority:/root/.Xauthority:rw
    privileged: true

여기서 중요한 것은 DISPLAY 환경변수 설정에 있어서 화면을 띄우고자 하는 '<Host OS IP>:0'을 넣어주어야 한다는 점이며, host의 경우 앞에서 언급한 xhost + <Server IP>로 특정 서버에 대한 접근을 허용해야 합니다. 추가로 ':0'의 의미는 디스플레이 포트를 의미합니다.

이후 해당 docker-compose.yml 를 바탕으로 이미지를 만들어 해당 컨테이너를 띄워줍니다.

% docker-compose build
% docker-compose up -d
% docker-compose exec --user root ros2 bash

이후 해당 컨테이너 내부에서 x11-apps 패키지 내부에 있는 xclock을 실행시키면 시계가 뜨는 것을 확인할 수 있습니다.

$ xclock

참고

• [blog] How to Set Up and Use X11 Forwarding on Linux and Mac: https://www.businessnewsdaily.com/11035-how-to-use-x11-forwarding.html
• [Official]XQuartz: https://www.xquartz.org/index.html
• [Github] X11 forwarding on macOS and docker: https://gist.github.com/sorny/969fe55d85c9b0035b0109a31cbcb088
• [StackOverFlow] X11 forwarding of a GUI app running in docker: https://stackoverflow.com/questions/44429394/x11-forwarding-of-a-gui-app-running-in-docker
• [Blog] X11 포워딩 하기 (macOS): https://blog.naver.com/PostView.naver?blogId=chcbaram&logNo=222920381690&categoryNo=0&parentCategoryNo=0&viewDate=&currentPage=1&postListTopCurrentPage=1&from=postView
• [Blog] How to install X Window System XQuartz on macOS for ssh X11 forwarding: https://www.cyberciti.biz/faq/apple-osx-mountain-lion-mavericks-install-xquartz-server/