Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improves docker X11 forwarding documentation #685

Merged
merged 3 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Guidelines for modifications:
* Vladimir Fokow
* Zhengyu Zhang
* Ziqi Fan
* Johnson Sun

## Acknowledgements

Expand Down
4 changes: 2 additions & 2 deletions docker/container.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 11 additions & 0 deletions docs/source/deployment/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,17 @@ directories to the ``docker/artifacts`` directory. This is useful for copying th
./docker/container.sh stop


X11 forwarding
~~~~~~~~~~~~~~

The container supports X11 forwarding, which allows the user to run GUI applications from the container and display them
on the host machine.

The first time a container is started with ``./docker/container.sh start``, the script prompts
the user whether to activate X11 forwarding. This will create a file ``docker/.container.yaml`` to store the user's choice.
Subsequently, X11 forwarding can be toggled by changing ``__ISAACLAB_X11_FORWARDING_ENABLED`` to 0 or 1 in ``docker/.container.yaml``.


Python Interpreter
~~~~~~~~~~~~~~~~~~

Expand Down
Loading