Home Explore Blog CI



docker

content/manuals/desktop/features/usbip.md
ba8fce73c4ce62cf3d5e742bd607ffe37b0420a2835b4d980000000300000f02
---
title: Using USB/IP with Docker Desktop
linkTitle: USB/IP support
weight: 50
description: How to use USB/IP in Docker Desktop
keywords: usb, usbip, docker desktop, macos, windows, linux
toc_max: 3
aliases:
- /desktop/usbip/
---

{{< summary-bar feature_name="USB/IP support" >}}

USB/IP enables you to share USB devices over the network, which can then be accessed from within Docker containers. This page focuses on sharing USB devices connected to the machine you run Docker Desktop on. You can repeat the following process to attach and use additional USB devices as needed.

> [!NOTE]
>
> Docker Desktop includes built-in drivers for many common USB devices but Docker can't guarantee every possible USB device works with this setup.

## Setup and use

### Step one: Run a USB/IP server

To use USB/IP, you need to run a USB/IP server. For this guide, the implementation provided by [jiegec/usbip](https://github.com/jiegec/usbip) will be used.

1. Clone the repository.

    ```console
    $ git clone https://github.com/jiegec/usbip
    $ cd usbip
    ```

2. Run the emulated Human Interface Device (HID) device example.

    ```console
    $ env RUST_LOG=info cargo run --example hid_keyboard
    ```

### Step two: Start a privileged Docker container

To attach the USB device, start a privileged Docker container with the PID namespace set to `host`:

```console
$ docker run --rm -it --privileged --pid=host alpine
```

`--privileged` gives the container full access to the host, and `--pid=host` allows it to share the host’s process namespace.

### Step three: Enter the mount namespace of PID 1

Inside the container, enter the mount namespace of the `init` process to gain access to the pre-installed USB/IP tools:

```console
$ nsenter -t 1 -m
```

### Step four: Use the USB/IP tools

Now you can use the USB/IP tools as you would on any other system:

#### List USB devices

To list exportable USB devices from the host:

```console
$ usbip list -r host.docker.internal
```

Expected output:

```console
Exportable USB devices
======================
 - host.docker.internal
      0-0-0: unknown vendor : unknown product (0000:0000)
           : /sys/bus/0/0/0
           : (Defined at Interface level) (00/00/00)
           :  0 - unknown class / unknown subclass / unknown protocol (03/00/00)
```

#### Attach a USB device

To attach a specific USB device, or the emulated keyboard in this case:

```console
$ usbip attach -r host.docker.internal -d 0-0-0
```

#### Verify device attachment

After attaching the emulated keyboard, check the `/dev/input` directory for the device node:

```console
$ ls /dev/input/
```

Example output:

```console
event0  mice
```

### Step five: Access the device from another container

While the initial container remains running to keep the USB device operational, you can access the attached device from another container. For example:

1. Start a new container with the attached device.

    ```console
    $ docker run --rm -it --device "/dev/input/event0" alpine
    ```

2. Install a tool like `evtest` to test the emulated keyboard.

    ```console
    $ apk add evtest
    $ evtest /dev/input/event0
    ```

3. Interact with the device, and observe the output.

    Example output:

    ```console
    Input driver version is 1.0.1
    Input device ID: bus 0x3 vendor 0x0 product 0x0 version 0x111
    ...
    Properties:
    Testing ... (interrupt to exit)
    Event: time 1717575532.881540, type 4 (EV_MSC), code 4 (MSC_SCAN), value 7001e
    Event: time 1717575532.881540, type 1 (EV_KEY), code 2 (KEY_1), value 1
    Event: time 1717575532.881540, -------------- SYN_REPORT ------------
    ...
    ```

> [!IMPORTANT]
>
> The initial container must remain running to maintain the connection to the USB device. Exiting the container will stop the device from working.

Chunks
992095e0 (1st chunk of `content/manuals/desktop/features/usbip.md`)
Title: Using USB/IP with Docker Desktop
Summary
This document explains how to use USB/IP in Docker Desktop to share USB devices over the network and access them from within Docker containers. It outlines the steps to run a USB/IP server, start a privileged Docker container, enter the mount namespace of PID 1, use the USB/IP tools to list and attach USB devices, and finally, access the device from another container. It uses an emulated HID keyboard as an example.