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

Docs: Add windows docker installation instruction #2821

Merged
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
7 changes: 6 additions & 1 deletion docs/developers/devel-env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,12 @@ Clone listenbrainz-server
-------------------------

ListenBrainz is hosted on GitHub at https://github.com/metabrainz/listenbrainz-server/.
You can use ``git`` to clone it (or your own fork) to your computer
You can use ``git`` to clone it (or your own fork) to your computer.

.. note::
Windows users are advised to clone the repository in their WSL2 file system to avoid code watcher issues.
Please refer to :ref:`run docker inside WSL <Windows Docker Installation>` for more
information.

.. code-block:: bash

Expand Down
29 changes: 29 additions & 0 deletions docs/developers/troubleshooting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
===============
Troubleshooting
===============

Docker Installations
--------------------

.. _Windows Docker Installation:

Windows
^^^^^^^

If changes to JS files are not being watched or hot reloaded by the host file system, follow
ykchong45 marked this conversation as resolved.
Show resolved Hide resolved
these steps:

1. Clone or move the project into your WSL2 file system.

2. Create a ``.wslconfig`` file under ``C:/Users/<user-name>/`` with the following content:

.. code-block:: bash

[wsl2]
localhostforwarding=true

3. To apply the changes, you may need to shut down the WSL 2 VM by running ``wsl --shutdown`` in
the command prompt. Then, restart your WSL instance.

For more detailed information, refer to the `wsl settings page
<https://learn.microsoft.com/en-us/windows/wsl/wsl-config#main-wsl-settings>`_.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Contents
developers/spark-architecture
developers/mapping
developers/commands
developers/troubleshooting

.. toctree::
:maxdepth: 2
Expand Down