Skip to content

Commit 671725c

Browse files
authored
[command-reference]: Document what "auto" means in container run (#765)
## Type of Change - [ ] Bug fix - [ ] New feature - [ ] Breaking change - [x] Documentation update ## Motivation and Context Closes #746 ## Testing - [ ] Tested locally - [ ] Added/updated tests - [x] Added/updated docs
1 parent da501ce commit 671725c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/command-reference.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,19 @@ container run [OPTIONS] IMAGE [COMMAND] [ARG...]
5454
* `--virtualization`: Expose virtualization capabilities to the container (requires host and guest support)
5555
* **Registry options**
5656
* `--scheme <scheme>`: Scheme to use when connecting to the container registry. One of (http, https, auto) (default: auto)
57+
58+
* **Behavior of `auto`**
59+
60+
When `auto` is selected, the target registry is considered **internal/local** if the registry host matches any of these criteria:
61+
- The host is a loopback address (e.g., `localhost`, `127.*`)
62+
- The host is within the `RFC1918` private IP ranges:
63+
- `10.*.*.*`
64+
- `192.168.*.*`
65+
- `172.16.*.*` through `172.31.*.*`
66+
- The host ends with the machine’s default container DNS domain (as defined in `DefaultsStore.Keys.defaultDNSDomain`, located [here](../Sources/ContainerPersistence/DefaultsStore.swift))
67+
68+
For internal/local registries, the client uses **HTTP**. Otherwise, it uses **HTTPS**.
69+
5770
* **Progress options**
5871
* `--disable-progress-updates`: Disable progress bar updates
5972
* **Global options**

0 commit comments

Comments
 (0)