Clarify X11 forwarding configs

isaac-sim · Jul 18, 2024 · 14f2ae8 · 14f2ae8
1 parent 05a2f3f
commit 14f2ae8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -54,6 +54,7 @@ Guidelines for modifications:
 * Vladimir Fokow
 * Zhengyu Zhang
 * Ziqi Fan
+* Johnson Sun
 
 ## Acknowledgements
 

diff --git a/docker/container.sh b/docker/container.sh
@@ -224,9 +224,9 @@ x11_check() {
     else
         echo "[INFO] X11 Forwarding is configured as $__ISAACLAB_X11_FORWARDING_ENABLED in .container.yaml"
         if [ "$__ISAACLAB_X11_FORWARDING_ENABLED" = "1" ]; then
-            echo "[INFO] To disable X11 forwarding, set __ISAACLAB_X11_FORWARDING_ENABLED=0 in .container.yaml"
+            echo "[INFO] To disable X11 forwarding, set \`__ISAACLAB_X11_FORWARDING_ENABLED: 0\` in .container.yaml"
         else
-            echo "[INFO] To enable X11 forwarding, set __ISAACLAB_X11_FORWARDING_ENABLED=1 in .container.yaml"
+            echo "[INFO] To enable X11 forwarding, set \`__ISAACLAB_X11_FORWARDING_ENABLED: 1\` in .container.yaml"
         fi
     fi
 

diff --git a/docs/source/deployment/docker.rst b/docs/source/deployment/docker.rst
@@ -136,6 +136,9 @@ directories to the ``docker/artifacts`` directory. This is useful for copying th
     # stop the container
     ./docker/container.sh stop
 
+To enable X11 forwarding, set ``__ISAACLAB_X11_FORWARDING_ENABLED: 1`` in ``docker/.container.yaml``,
+and rerun ``./docker/container.sh stop`` and ``./docker/container.sh start``. This will allow apps to behave as local GUI windows.
+
 
 Python Interpreter
 ~~~~~~~~~~~~~~~~~~