Skip to content

Improve README.md documentation for Docker installation prerequisites #261

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.

Sign up for GitHub

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

Merged
ericcurtin merged 1 commit into from
Oct 20, 2025
Merged

Improve README.md documentation for Docker installation prerequisites #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
56 changes: 54 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,69 @@ This package supports the Docker Model Runner in Docker Desktop and Docker Engin

### Installation

### Docker Desktop (macOS and Windows)
Copy link

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

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

[nitpick] Heading hierarchy is inconsistent: 'Installation' and its subsections use the same heading level (###). To reflect nesting, demote the subsection headers under 'Installation' (e.g., use #### for 'Docker Desktop', 'Docker Engine', 'Verifying Your Installation', and 'Troubleshooting').

Copilot uses AI. Check for mistakes.

For macOS and Windows, install Docker Desktop:

https://docs.docker.com/desktop/

For Linux, install Docker Engine:
Docker Model Runner is included in Docker Desktop.

### Docker Engine (Linux)

For Linux, install Docker Engine from the official Docker repository:

```bash
curl -fsSL https://get.docker.com | sudo bash
```

Docker Model Runner is included in the above tools.
Docker Model Runner is included in Docker Engine when installed from Docker's official repositories.

### Verifying Your Installation

To verify that Docker Model Runner is available:

```bash
# Check if the Docker CLI plugin is available
docker model --help

# Check Docker version
docker version
Copy link
Copy Markdown
Contributor

@ilopezluna ilopezluna Oct 20, 2025

Choose a reason for hiding this comment

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

or maybe docker model version?

Copy link
Copy Markdown
Contributor Author

@ericcurtin ericcurtin Oct 20, 2025

Choose a reason for hiding this comment

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

Lets add both


# Check Docker Model Runner version
docker model version
```

If `docker model` is not available, see the troubleshooting section below.

### Troubleshooting: Docker Installation Source

If you encounter errors like `Package 'docker-model-plugin' has no installation candidate` or `docker model` command is not found:

1. **Check your Docker installation source:**
```bash
# Check Docker version
docker version
Comment thread
ericcurtin marked this conversation as resolved.

# Check Docker Model Runner version
docker model version
```

Look for the source in the output. If it shows a package from your distro, you'll need to reinstall from Docker's official repositories.
Comment thread
ericcurtin marked this conversation as resolved.
Comment on lines +51 to +59
Copy link

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

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

The 'docker version' output does not indicate the package source (distro vs Docker’s repo). Replace this guidance with package manager checks; for example on Debian/Ubuntu use 'apt-cache policy docker-ce docker.io' (or 'dpkg -l | grep -E "^(ii|hi)\s+(docker|docker.io|docker-ce|docker-ce-cli|containerd|containerd.io)"'), and on RHEL/Fedora use 'rpm -qi docker-ce' or 'dnf info docker-ce' to verify the repository.

Suggested change
```bash
# Check Docker version
docker version
# Check Docker Model Runner version
docker model version
```
Look for the source in the output. If it shows a package from your distro, you'll need to reinstall from Docker's official repositories.
For **Debian/Ubuntu**, check the package source using:
```bash
apt-cache policy docker-ce docker.io
# Or
dpkg -l | grep -E "^(ii|hi)\s+(docker|docker.io|docker-ce|docker-ce-cli|containerd|containerd.io)"

For RHEL/Fedora, use:

rpm -qi docker-ce
# Or
dnf info docker-ce

If the package is from your distro's repository (not Docker's official repo), you'll need to reinstall from Docker's official repositories.

Copilot uses AI. Check for mistakes.

2. **Remove the distro version and install from Docker's official repository:**
```bash
# Remove distro version (Ubuntu/Debian example)
sudo apt-get purge docker docker.io containerd runc
Comment on lines +63 to +64
Copy link

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

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

The uninstall list may leave conflicting packages behind. Align with Docker's official guidance by also removing related packages like 'docker-doc', 'docker-compose', 'docker-compose-plugin', and 'podman-docker' (or link to the official 'Uninstall old versions' docs). Example: 'sudo apt-get remove docker docker-engine docker.io docker-doc docker-compose docker-compose-plugin containerd runc'.

Suggested change
# Remove distro version (Ubuntu/Debian example)
sudo apt-get purge docker docker.io containerd runc
# Remove old Docker versions and related packages (Ubuntu/Debian example)
sudo apt-get purge docker docker-engine docker.io docker-doc docker-compose docker-compose-plugin podman-docker containerd runc
# See Docker's official uninstall instructions for more details:
# https://docs.docker.com/engine/install/ubuntu/#uninstall-old-versions

Copilot uses AI. Check for mistakes.

# Install from Docker's official repository
curl -fsSL https://get.docker.com | sudo bash

Comment thread
ericcurtin marked this conversation as resolved.
# Verify Docker Model Runner is available
docker model --help
```

3. **For NVIDIA DGX systems:** If Docker came pre-installed, verify it's from Docker's official repositories. If not, follow the reinstallation steps above.

For more details refer to:

Expand Down
Loading