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.

Sign up for GitHub

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

Jump to bottom

Improves docker X11 forwarding documentation #685

Merged
merged 3 commits into from
Jul 26, 2024
Merged

Improves docker X11 forwarding documentation #685

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14f2ae8
Clarify X11 forwarding configs
j3soon Jul 15, 2024
e480368
Update docs/source/deployment/docker.rst
j3soon Jul 25, 2024
ba29e6a
Merge branch 'main' into docs/x11-forwarding
Dhoeller19 Jul 25, 2024
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
View file
Open in desktop
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
View file
Open in desktop
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
3 changes: 3 additions & 0 deletions docs/source/deployment/docker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
j3soon marked this conversation as resolved.
Show resolved Hide resolved


Python Interpreter
~~~~~~~~~~~~~~~~~~
Expand Down