mirror of https://github.com/docker/docs.git
113 lines
3.3 KiB
YAML
113 lines
3.3 KiB
YAML
command: docker image import
|
||
aliases: docker image import, docker import
|
||
short: Import the contents from a tarball to create a filesystem image
|
||
long: |-
|
||
You can specify a `URL` or `-` (dash) to take data directly from `STDIN`. The
|
||
`URL` can point to an archive (.tar, .tar.gz, .tgz, .bzip, .tar.xz, or .txz)
|
||
containing a filesystem or to an individual file on the Docker host. If you
|
||
specify an archive, Docker untars it in the container relative to the `/`
|
||
(root). If you specify an individual file, you must specify the full path within
|
||
the host. To import from a remote location, specify a `URI` that begins with the
|
||
`http://` or `https://` protocol.
|
||
|
||
The `--change` option applies `Dockerfile` instructions to the image that is
|
||
created. Supported `Dockerfile` instructions:
|
||
`CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`
|
||
usage: docker image import [OPTIONS] file|URL|- [REPOSITORY[:TAG]]
|
||
pname: docker image
|
||
plink: docker_image.yaml
|
||
options:
|
||
- option: change
|
||
shorthand: c
|
||
value_type: list
|
||
description: Apply Dockerfile instruction to the created image
|
||
deprecated: false
|
||
hidden: false
|
||
experimental: false
|
||
experimentalcli: false
|
||
kubernetes: false
|
||
swarm: false
|
||
- option: message
|
||
shorthand: m
|
||
value_type: string
|
||
description: Set commit message for imported image
|
||
deprecated: false
|
||
hidden: false
|
||
experimental: false
|
||
experimentalcli: false
|
||
kubernetes: false
|
||
swarm: false
|
||
- option: platform
|
||
value_type: string
|
||
description: Set platform if server is multi-platform capable
|
||
deprecated: false
|
||
hidden: false
|
||
min_api_version: "1.32"
|
||
experimental: false
|
||
experimentalcli: false
|
||
kubernetes: false
|
||
swarm: false
|
||
inherited_options:
|
||
- option: help
|
||
value_type: bool
|
||
default_value: "false"
|
||
description: Print usage
|
||
deprecated: false
|
||
hidden: true
|
||
experimental: false
|
||
experimentalcli: false
|
||
kubernetes: false
|
||
swarm: false
|
||
examples: |-
|
||
### Import from a remote location
|
||
|
||
This creates a new untagged image.
|
||
|
||
```console
|
||
$ docker import https://example.com/exampleimage.tgz
|
||
```
|
||
|
||
### Import from a local file
|
||
|
||
Import to docker via pipe and `STDIN`.
|
||
|
||
```console
|
||
$ cat exampleimage.tgz | docker import - exampleimagelocal:new
|
||
```
|
||
|
||
Import with a commit message.
|
||
|
||
```console
|
||
$ cat exampleimage.tgz | docker import --message "New image imported from tarball" - exampleimagelocal:new
|
||
```
|
||
|
||
Import to docker from a local archive.
|
||
|
||
```console
|
||
$ docker import /path/to/exampleimage.tgz
|
||
```
|
||
|
||
### Import from a local directory
|
||
|
||
```console
|
||
$ sudo tar -c . | docker import - exampleimagedir
|
||
```
|
||
|
||
### Import from a local directory with new configurations
|
||
|
||
```console
|
||
$ sudo tar -c . | docker import --change "ENV DEBUG=true" - exampleimagedir
|
||
```
|
||
|
||
Note the `sudo` in this example – you must preserve
|
||
the ownership of the files (especially root ownership) during the
|
||
archiving with tar. If you are not root (or the sudo command) when you
|
||
tar, then the ownerships might not get preserved.
|
||
deprecated: false
|
||
hidden: false
|
||
experimental: false
|
||
experimentalcli: false
|
||
kubernetes: false
|
||
swarm: false
|
||
|