Skip to content

Commit

Permalink
specifying xquartz requirement as optional for the remote graphical d…
Browse files Browse the repository at this point in the history
…esktop users
  • Loading branch information
ShutdownRepo committed Nov 28, 2023
1 parent 54a3d15 commit 216080e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
8 changes: 6 additions & 2 deletions source/getting-started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,11 @@ Additional dependencies may be required depending on the host OS.

.. tab:: macOS

To support graphical applications (:ref:`display sharing functionality <feature_display_sharing>`, e.g. Bloodhound, Wireshark, Burp, etc.), additional dependencies and configuration are required:
To support graphical applications (:ref:`display sharing functionality <feature_x11_sharing>`, e.g. Bloodhound, Wireshark, Burp, etc.), additional dependencies and configuration are required:

.. hint::

The XQuartz requirement below is now optional if using the (beta) Graphical Remote Desktop feature instead of X11 sharing (join our Discord to know more about this beta feature).

* `XQuartz <https://www.xquartz.org/>`__ must be installed
* The XQuartz config ``Allow connections from network clients`` must be set to true
Expand All @@ -86,7 +90,7 @@ Additional dependencies may be required depending on the host OS.

.. group-tab:: Windows

To support graphical applications (:ref:`display sharing functionality <feature_display_sharing>`, e.g. Bloodhound, Wireshark, Burp, etc.), additional dependencies and configuration are required:
To support graphical applications (:ref:`display sharing functionality <feature_x11_sharing>`, e.g. Bloodhound, Wireshark, Burp, etc.), additional dependencies and configuration are required:

* Windows **10** (up to date), or Windows **11**, is required
* **Docker Desktop** installed on the Windows host
Expand Down
10 changes: 5 additions & 5 deletions source/the-exegol-project/python-wrapper.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Below is a, non-exhaustive, list of what the wrapper supports:
=================================================== =============
Feature Description
=================================================== =============
:ref:`Display sharing<feature_display_sharing>` Sharing of the graphic environment between the container and the host
:ref:`Display sharing<feature_x11_sharing>` Sharing of the graphic environment between the container and the host
:ref:`Workspace<feature_workspace>` Persistent and shared workspace with the host
:ref:`Update-fs<feature_update_fs>` Permission sharing between the container and the host
:ref:`OpenVPN connection<feature_ovpn>` Opening an isolated VPN tunnel dedicated to the exegol container
Expand Down Expand Up @@ -61,12 +61,12 @@ Features

The Exegol wrapper has many features to automatically and transparently manage different configurations to facilitate the use and creation of docker containers.

.. _feature_display_sharing:
.. _feature_x11_sharing:

Display sharing
---------------
X11 sharing (GUI)
-----------------

By default exegol configures the new container and host to allow the execution to the display of graphical window launched from an exegol container.
By default exegol configures the new container and host to allow the execution to the display of graphical window launched from an exegol container. This is achieved to X11 sharing.

For example, if bloodhound is launched in an exegol container, the graphical window (GUI) will be displayed in the user's graphic environment.

Expand Down

0 comments on commit 216080e

Please sign in to comment.