Skip to main content
Version: Next

Installation

This guide walks you through how you can install and run Apache APISIX in your environment.

Refer to the Getting Started guide for a quick walk-through on running Apache APISIX.

Installing APISIX#

APISIX can be installed by the different methods listed below:

First clone the apisix-docker repository:

git clone https://github.com/apache/apisix-docker.gitcd apisix-docker/example

Now, you can use docker-compose to start APISIX.

docker-compose -p docker-apisix up -d

Installing etcd#

APISIX uses etcd to save and synchronize configuration. Before installing APISIX, you need to install etcd on your machine.

It would be installed automatically if you choose the Docker or Helm install method while installing APISIX. If you choose a different method or you need to install it manually, follow the steps shown below:

ETCD_VERSION='3.5.4'wget https://github.com/etcd-io/etcd/releases/download/v${ETCD_VERSION}/etcd-v${ETCD_VERSION}-linux-amd64.tar.gztar -xvf etcd-v${ETCD_VERSION}-linux-amd64.tar.gz && \  cd etcd-v${ETCD_VERSION}-linux-amd64 && \  sudo cp -a etcd etcdctl /usr/bin/nohup etcd >/tmp/etcd.log 2>&1 &

Next steps#

Updating Admin API key#

It is recommended to modify the Admin API key to ensure security.

You can update your configuration file as shown below:

conf/config.yaml
apisix:  admin_key    -      name: "admin"      key: newsupersecurekey      role: admin

Now, to access the Admin API, you can use the new key:

curl http://127.0.0.1:9080/apisix/admin/routes?api_key=newsupersecurekey -i

Adding APISIX systemd unit file#

If you installed APISIX via RPM, the APISIX unit file will already be configured and you can start APISIX by:

systemctl start apisixsystemctl stop apisix

If you installed APISIX through other methods, you can create /usr/lib/systemd/system/apisix.service and add the configuration from the template.

See the Getting Started guide for a quick walk-through of using APISIX.