Skip to content

Conversation

@p1-0tr
Copy link

@p1-0tr p1-0tr commented Nov 29, 2024

Description

Add a manual on using USB/IP in DD

Related issues or tickets

Reviews

  • Technical review
  • Editorial review
  • Product review

@github-actions github-actions bot added the area/desktop Issue affects a desktop edition of Docker. E.g docker for mac label Nov 29, 2024
@netlify
Copy link

netlify bot commented Nov 29, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit a54de63
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/674d9fad441bb40008bf58ba
😎 Deploy Preview https://deploy-preview-21533--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@p1-0tr p1-0tr force-pushed the ps-add-usbip-manual branch 4 times, most recently from 91a6c76 to 43ee8f1 Compare November 29, 2024 12:50
@p1-0tr p1-0tr marked this pull request as ready for review November 29, 2024 12:54
@p1-0tr p1-0tr requested a review from aevesdocker as a code owner November 29, 2024 12:55
@p1-0tr p1-0tr force-pushed the ps-add-usbip-manual branch from 43ee8f1 to 0bdc58b Compare November 29, 2024 13:06
Copy link
Contributor

@doringeman doringeman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link
Contributor

@aevesdocker aevesdocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @p1-0tr, looks like a lot of comments but they're mostly style guide nits.

Also wondering if this FAQ needs to be adapted as part of this PR? https://deploy-preview-21533--docsdocker.netlify.app/desktop/troubleshoot-and-support/faqs/general/#can-i-pass-through-a-usb-device-to-a-container

@p1-0tr p1-0tr force-pushed the ps-add-usbip-manual branch 3 times, most recently from 86ce2dd to d3be1ce Compare December 2, 2024 11:38
>
> The initial container must remain running to maintain the connection to the USB device. Exiting the container will stop the device from working.

- You can repeat the following process to attach and use additional USB devices as needed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd move this content and the point below up to the intro paragraph. Think this should be made clear at the top of the page

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the last bullet a NOTE block.

...
```

### Notes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Notes

Can be removed since we're moving the bullet points

@p1-0tr
Copy link
Author

p1-0tr commented Dec 2, 2024

Thank you @p1-0tr, looks like a lot of comments but they're mostly style guide nits.

Thanks :)

Also wondering if this FAQ needs to be adapted as part of this PR? https://deploy-preview-21533--docsdocker.netlify.app/desktop/troubleshoot-and-support/faqs/general/#can-i-pass-through-a-usb-device-to-a-container

I fixed up the FAQ


It is not possible to pass through a USB device (or a
serial port) to a container as it requires support at the hypervisor level.
While USB device pass through is not supported by Docker Desktop, USB over IP can be used to connect common USB devices to the Docker Desktop VM and in turn be forwarded to a container. For more details, see [how to use USB/IP in Docker Desktop](/manuals/desktop/features/usbip.md).
Copy link
Contributor

@aevesdocker aevesdocker Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
While USB device pass through is not supported by Docker Desktop, USB over IP can be used to connect common USB devices to the Docker Desktop VM and in turn be forwarded to a container. For more details, see [how to use USB/IP in Docker Desktop](/manuals/desktop/features/usbip.md).
Docker Desktop does not support direct USB device passthrough. However, you can use USB over IP to connect common USB devices to the Docker Desktop VM and in turn be forwarded to a container. For more details, see [Using USB/IP with Docker Desktop](/manuals/desktop/features/usbip.md).

@p1-0tr p1-0tr force-pushed the ps-add-usbip-manual branch 2 times, most recently from 6b1b403 to 7057814 Compare December 2, 2024 11:52
Signed-off-by: Piotr Stankiewicz <piotr.stankiewicz@docker.com>
@p1-0tr p1-0tr force-pushed the ps-add-usbip-manual branch from 7057814 to a54de63 Compare December 2, 2024 11:53
Copy link
Contributor

@aevesdocker aevesdocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @p1-0tr LGTM :shipit:

@aevesdocker aevesdocker merged commit 655a6c8 into docker:main Dec 2, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/desktop Issue affects a desktop edition of Docker. E.g docker for mac

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants