Docker images are not official ASF releases but provided for convenience. Recommended usage is always to build the source.

How To Build Image

The master branch is for the version of Apache APISIX 2.x. If you need a previous version, please build from the v1.x tag.

Build an image from source

1. Build from release version:

# Assign Apache release version to variable `APISIX_VERSION`, for example: 2.9.
# The latest release version can be find at `https://github.com/apache/apisix/releases`

export APISIX_VERSION=2.9

# build alpine based image
make build-on-alpine

# build centos based image
make build-on-centos

2. Build from master branch version, which has latest code(ONLY for the developer's convenience):

export APISIX_VERSION=master

# build alpine based image
make build-on-alpine

# build centos based image
make build-on-centos

3. Build from local code:

# To copy apisix into image, we need to include it in build context
cp -r <APISIX-PATH> ./apisix

export APISIX_PATH=./apisix
make build-on-alpine-local

# Might need root privilege if encounter "error checking context: 'can't start'"

Note: For Chinese, the following command is always recommended. The additional build argument ENABLE_PROXY=true will enable proxy to definitely accelerate the progress.

$ make build-on-alpine-cn

Manual deploy apisix via docker

Manual deploy

QuickStart via docker-compose

start all modules with docker-compose

cd example
docker-compose -p docker-apisix up -d

You can refer to the docker-compose example for more try.

Quick test with all dependencies in one Docker container

• All in one Docker container for Apache APISIX

make build-all-in-one

# launch APISIX container
docker run -d \
-p 9080:9080 -p 9091:9091 -p 2379:2379 \
-v `pwd`/all-in-one/apisix/config.yaml:/usr/local/apisix/conf/config.yaml \
apache/apisix:whole

• All in one Docker container for Apache apisix-dashboard

The latest version of apisix-dashboard is 2.9 and can be used with APISIX 2.10.

make build-dashboard

# launch APISIX-dashboard container
docker run -d \
-p 9080:9080 -p 9091:9091 -p 2379:2379 -p 9000:9000 \
-v `pwd`/all-in-one/apisix/config.yaml:/usr/local/apisix/conf/config.yaml \
-v `pwd`/all-in-one/apisix-dashboard/conf.yaml:/usr/local/apisix-dashboard/conf/conf.yaml \
apache/apisix-dashboard:whole

Tips: If there is a port conflict, please modify the host port through docker run -p, e.g.

# launch APISIX-AIO container
docker run -d \
-p 19080:9080 -p 19091:9091 -p 12379:2379 -p 19000:9000 \
-v `pwd`/all-in-one/apisix/config.yaml:/usr/local/apisix/conf/config.yaml \
-v `pwd`/all-in-one/apisix-dashboard/conf.yaml:/usr/local/apisix-dashboard/conf/conf.yaml \
apache/apisix-dashboard:whole

Note

Apache APISIX expose prometheus metrics port on 9091, and you need to expose it to 0.0.0.0 instead of the default 127.0.0.1 to make it accessible outside docker. You could achieve it with adding the following to your config.yaml.

plugin_attr:
  prometheus:
    export_addr:
      ip: "0.0.0.0"
      port: 9091