Skip to content

Commit ab7cdb8

Browse files
authored
Improves docker X11 forwarding documentation (#685)
# Description Clarify X11 forwarding configs in docs and warning messages. ## Type of change - Bug fix (non-breaking change which fixes an issue) ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there
1 parent 4a3f07a commit ab7cdb8

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

CONTRIBUTORS.md

+1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Guidelines for modifications:
5454
* Vladimir Fokow
5555
* Zhengyu Zhang
5656
* Ziqi Fan
57+
* Johnson Sun
5758

5859
## Acknowledgements
5960

docker/container.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -224,9 +224,9 @@ x11_check() {
224224
else
225225
echo "[INFO] X11 Forwarding is configured as $__ISAACLAB_X11_FORWARDING_ENABLED in .container.yaml"
226226
if [ "$__ISAACLAB_X11_FORWARDING_ENABLED" = "1" ]; then
227-
echo "[INFO] To disable X11 forwarding, set __ISAACLAB_X11_FORWARDING_ENABLED=0 in .container.yaml"
227+
echo "[INFO] To disable X11 forwarding, set \`__ISAACLAB_X11_FORWARDING_ENABLED: 0\` in .container.yaml"
228228
else
229-
echo "[INFO] To enable X11 forwarding, set __ISAACLAB_X11_FORWARDING_ENABLED=1 in .container.yaml"
229+
echo "[INFO] To enable X11 forwarding, set \`__ISAACLAB_X11_FORWARDING_ENABLED: 1\` in .container.yaml"
230230
fi
231231
fi
232232

docs/source/deployment/docker.rst

+11
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,17 @@ directories to the ``docker/artifacts`` directory. This is useful for copying th
137137
./docker/container.sh stop
138138
139139
140+
X11 forwarding
141+
~~~~~~~~~~~~~~
142+
143+
The container supports X11 forwarding, which allows the user to run GUI applications from the container and display them
144+
on the host machine.
145+
146+
The first time a container is started with ``./docker/container.sh start``, the script prompts
147+
the user whether to activate X11 forwarding. This will create a file ``docker/.container.yaml`` to store the user's choice.
148+
Subsequently, X11 forwarding can be toggled by changing ``__ISAACLAB_X11_FORWARDING_ENABLED`` to 0 or 1 in ``docker/.container.yaml``.
149+
150+
140151
Python Interpreter
141152
~~~~~~~~~~~~~~~~~~
142153

0 commit comments

Comments
 (0)