Merge pull request #613 from tonistiigi/docs-update

readme: update installation instructions
pull/618/head
Akihiro Suda 4 years ago committed by GitHub
commit 4fec647b9d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -14,7 +14,7 @@ Key features:
- Multiple builder instance support - Multiple builder instance support
- Multi-node builds for cross-platform images - Multi-node builds for cross-platform images
- Compose build support - Compose build support
- WIP: High-level build constructs (`bake`) - High-level build constructs (`bake`)
- In-container driver support (both Docker and Kubernetes) - In-container driver support (both Docker and Kubernetes)
# Table of Contents # Table of Contents
@ -45,12 +45,11 @@ Key features:
# Installing # Installing
Using `buildx` as a docker CLI plugin requires using Docker 19.03. A limited set of functionality works with older versions of Docker when invoking the binary directly. Using `buildx` as a docker CLI plugin requires using Docker 19.03 or newer. A limited set of functionality works with older versions of Docker when invoking the binary directly.
### Docker CE ### Docker
`buildx` comes bundled with Docker CE starting with 19.03, but requires experimental mode to be enabled on the Docker CLI. `buildx` comes bundled with Docker Desktop and in latest Docker CE packages.
To enable it, `"experimental": "enabled"` can be added to the CLI configuration file `~/.docker/config.json`. An alternative is to set the `DOCKER_CLI_EXPERIMENTAL=enabled` environment variable.
### Binary release ### Binary release
@ -63,13 +62,8 @@ chmod a+x ~/.docker/cli-plugins/docker-buildx
# Building # Building
### with Docker 18.09+
```
$ git clone git://github.com/docker/buildx && cd buildx
$ make install
```
### with buildx or Docker 19.03 ### with buildx or Docker 19.03+
``` ```
$ export DOCKER_BUILDKIT=1 $ export DOCKER_BUILDKIT=1
$ docker build --platform=local -o . git://github.com/docker/buildx $ docker build --platform=local -o . git://github.com/docker/buildx
@ -77,6 +71,12 @@ $ mkdir -p ~/.docker/cli-plugins
$ mv buildx ~/.docker/cli-plugins/docker-buildx $ mv buildx ~/.docker/cli-plugins/docker-buildx
``` ```
### with Docker 18.09+
```
$ git clone git://github.com/docker/buildx && cd buildx
$ make install
```
# Getting started # Getting started
## Building with buildx ## Building with buildx
@ -159,6 +159,8 @@ Currently, the bake command supports building images from compose files, similar
There is also support for custom build rules from HCL/JSON files allowing better code reuse and different target groups. The design of bake is in very early stages and we are looking for feedback from users. There is also support for custom build rules from HCL/JSON files allowing better code reuse and different target groups. The design of bake is in very early stages and we are looking for feedback from users.
[`buildx bake` Reference Docs](docs/reference/buildx_bake.md)
# Setting buildx as default builder in Docker 19.03+ # Setting buildx as default builder in Docker 19.03+
Running `docker buildx install` sets up `docker builder` command as an alias to `docker buildx`. This results in the ability to have `docker build` use the current buildx builder. Running `docker buildx install` sets up `docker builder` command as an alias to `docker buildx`. This results in the ability to have `docker build` use the current buildx builder.

@ -33,6 +33,10 @@ Build from a file
Bake is a high-level build command. Each specified target will run in parallel Bake is a high-level build command. Each specified target will run in parallel
as part of the build. as part of the build.
Read [High-level build options](https://github.com/docker/buildx#high-level-build-options) for introduction.
Please note that `buildx bake` command may receive backwards incompatible features in the future if needed. We are looking for feedback on improving the command and extending the functionality further.
## Examples ## Examples
### <a name="file"></a> Specify a build definition file (-f, --file) ### <a name="file"></a> Specify a build definition file (-f, --file)

Loading…
Cancel
Save