Skip to content

Commit

Permalink
docs: add a note to documentation that USBProxy requires root privile…
Browse files Browse the repository at this point in the history
…ges on macOS
  • Loading branch information
antoinevg committed Aug 19, 2024
1 parent 3a31934 commit 421f4ad
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/source/getting_started_usbproxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,21 @@ Create a new Python file called ``usbproxy.py`` with the following content:

Open a terminal and run:

.. code-block :: sh
.. tab:: Linux

python ./usbproxy.py
.. code-block :: sh
python ./usbproxy.py
.. tab:: macOS

.. note::

USBProxy requires root privileges on macOS in order to claim the device being proxied from the operating system.

.. code-block :: sh
sudo python ./usbproxy.py
If all goes well you should see the output from device enumeration in your terminal and the proxied USB device should be detected by the target computer.

Expand Down

0 comments on commit 421f4ad

Please sign in to comment.