Skip to content
Snippets Groups Projects
Commit dd0b5ee9 authored by Jan David Mol's avatar Jan David Mol
Browse files

L2SS-434: Added faq entries for Windows

parent c7420dc6
No related branches found
No related tags found
1 merge request!150L2SS-434: Add sphinx documentation content
...@@ -59,5 +59,5 @@ If Jive does not appear, check ``docker logs jive`` to see what went wrong. ...@@ -59,5 +59,5 @@ If Jive does not appear, check ``docker logs jive`` to see what went wrong.
For information on how to use Jive, see https://tango-controls.readthedocs.io/en/latest/tools-and-extensions/built-in/jive/. For information on how to use Jive, see https://tango-controls.readthedocs.io/en/latest/tools-and-extensions/built-in/jive/.
.. note:: If you need an X11 server on Windows, install `VcXsrv <https://sourceforge.net/projects/vcxsrv/>`_, disable access control during its startup, and use ``export DISPLAY=host.docker.internal:0`` in WSL. .. note:: If you need an X11 server on Windows, see :ref:`x11_on_windows`.
...@@ -27,6 +27,32 @@ You have to explicitly stop a container to prevent it from restarting. Use:: ...@@ -27,6 +27,32 @@ You have to explicitly stop a container to prevent it from restarting. Use::
or plain ``make stop`` to stop all of them. or plain ``make stop`` to stop all of them.
Windows
--------------------------------------------------------------------------------------------------------------
How do I develop from Windows?
``````````````````````````````````````````````````````````````````````````````````````````````````````````````
Our setup is Linux-based, so the easiest way to develop is by using WSL2, which lets you run a Linux distro under Windows. You'll need to:
- Install WSL2. See f.e. https://www.omgubuntu.co.uk/how-to-install-wsl2-on-windows-10
- Install `Docker Desktop <https://hub.docker.com/editions/community/docker-ce-desktop-windows/>`_
- Enable the WSL2 backend in Docker Desktop
- We also recommend to install `Windows Terminal <https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701>`_
.. _x11_on_windows:
How do I run X11 applications on Windows?
``````````````````````````````````````````````````````````````````````````````````````````````````````````````
If you need an X11 server on Windows:
- Install `VcXsrv <https://sourceforge.net/projects/vcxsrv/>`_
- Disable access control during its startup,
- Use ``export DISPLAY=host.docker.internal:0`` in WSL.
You should now be able to run X11 applications from WSL and Docker. Try running ``xterm`` or ``xeyes`` to test.
SSTs/XSTs SSTs/XSTs
-------------------------------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------------------------------
......
...@@ -41,4 +41,4 @@ If LogViewer does not appear, check ``docker logs logviewer`` to see what went w ...@@ -41,4 +41,4 @@ If LogViewer does not appear, check ``docker logs logviewer`` to see what went w
For information on how to use the LogViewer, see https://tango-controls.readthedocs.io/en/latest/tools-and-extensions/built-in/logviewer/logviewer.html. For information on how to use the LogViewer, see https://tango-controls.readthedocs.io/en/latest/tools-and-extensions/built-in/logviewer/logviewer.html.
.. note:: If you need an X11 server on Windows, install `VcXsrv <https://sourceforge.net/projects/vcxsrv/>`_, disable access control during its startup, and use ``export DISPLAY=host.docker.internal:0`` in WSL. .. note:: If you need an X11 server on Windows, see :ref:`x11_on_windows`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment