1.安装APISIX
1.1 下载 apisix-docker 仓库
git clone https://github.com/apache/apisix-docker.git cd apisix-docker/example
1.2 权限处理
# 解决 etcd 权限报错 chmod -R 777 ./
1.3 使用 docker-compose 启用 APISIX
# -p 指定项目名;-d 后台运行 docker-compose -p apisix up -d
1.4 核心端口说明
- 9080: HTTP 代理端口(客户端访问)
- 9443: HTTPS 代理端口
- 9180: Admin API 端口
- 9180/UI: Dashboard 管理面板
- 2379:etcd
2. 配置 APISIX
通过修改本地 ./apisix_conf/config.yaml 文件,或者在启动 APISIX 时使用 -c 或 --config 添加文件路径参数 apisix start -c <path string>,完成对 APISIX 服务本身的基本配置。默认配置不应修改,可以在 apisix/cli/config.lua 中找到。
比如将 APISIX 默认监听端口修改为 8000,其他配置保持默认,在 ./apisix_conf/config.yaml 中只需这样配置:
./apisix_conf/config.yaml
apisix: node_listen: 8000 # APISIX listening port
比如指定 APISIX 默认监听端口为 8000,并且设置 etcd 地址为 http://foo:2379,其他配置保持默认。在 ./apisix_conf/config.yaml 中只需这样配置:
./apisix_conf/config.yaml
apisix:
node_listen: 8000 # APISIX listening port
deployment:
role: traditional
role_traditional:
config_provider: etcd
etcd:
host:
- "http://foo:2379"
【注意】请不要手动修改 APISIX 安装目录下的
./apisix_conf/nginx.conf文件。当 APISIX 启动时,会根据config.yaml的配置自动生成新的nginx.conf并自动启动服务。
3. 更新 Admin API key
建议修改 Admin API 的 key,保护 APISIX 的安全。
请参考如下信息更新配置文件:
完整路径:apisix-docker/example/apisix_conf/config.yaml
./apisix_conf/config.yaml
deployment:
admin:
admin_key:
- name: "admin"
key: newsupersecurekey # 请修改 key 的值
role: admin
更新完成后,你可以使用新的 key 访问 Admin API:
curl http://127.0.0.1:9180/apisix/admin/routes?api_key=newsupersecurekey -i
4. 重用管理命令
# -p 指定项目名;-d 后台运行 docker-compose -p apisix up -d # 停止 docker-compose -p apisix stop # 重启 docker-compose -p apisix restart # 停止并删除容器/网络 docker-compose -p apisix down # 查看日志 docker-compose -p apisix logs -f apisix # 查看etcd日志 docker logs etcd