apisix/conf/config.yaml

apisix:
  node_listen: 9080              # APISIX listening port
  node_ssl_listen: 9443
  enable_heartbeat: true
  enable_admin: true
  enable_debug: false
  enable_ipv6: true
  config_center: etcd             # etcd: use etcd to store the config value
                                  # yaml: fetch the config value from local yaml file `/your_path/conf/apisix.yaml`
  # allow_admin:                  # http://nginx.org/en/docs/http/ngx_http_access_module.html#allow
  #   - 127.0.0.0/24              # If we don't set any IP list, then any IP access is allowed by default.
  #   - "::/64"
  # port_admin: 9180              # use a separate port
  real_ip_header: "X-Real-IP"     # http://nginx.org/en/docs/http/ngx_http_realip_module.html#real_ip_header
  real_ip_from:                   # http://nginx.org/en/docs/http/ngx_http_realip_module.html#set_real_ip_from
    - 127.0.0.1
    - 'unix:'
  router:
    http: 'radixtree_uri'         # r3_uri: match route by uri(base on r3)
                                  # r3_host_uri: match route by host + uri(base on r3)
                                  # radixtree_uri: match route by uri(base on radixtree)

    ssl: 'radixtree_sni'          # r3_sni: match route by SNI(base on r3)
                                  # radixtree_sni: match route by SNI(base on radixtree)
  # stream_proxy:                 # TCP/UDP proxy
  #   tcp:                        # TCP proxy port list
  #     - 9100
  #     - 9101
  #   udp:                        # UDP proxy port list
  #     - 9200
  #     - 9211

etcd:
  host: "http://127.0.0.1:2379"   # etcd address
  prefix: "/apisix"               # apisix configurations prefix
  timeout: 1                      # 1 seconds

plugins:                          # plugin list
  - example-plugin
  - limit-req
  - limit-count
  - limit-conn
  - key-auth
  - prometheus
  - node-status
  - jwt-auth
  - zipkin
  - ip-restriction
  - grpc-transcode
  - serverless-pre-function
  - serverless-post-function
  - openid-connect

stream_plugins:
  - mqtt-proxy
CLI: generated different nginx.conf for different OS. 2019-06-03 16:15:57 +08:00			`apisix:`
feature: support to load routes from local yaml file. (#464) * feature: support to load routes from local yaml file. 2019-09-09 17:42:20 +08:00			`node_listen: 9080 # APISIX listening port`
Support configure node_ssl_listen 2019-07-04 22:44:57 +08:00			`node_ssl_listen: 9443`
change: added a global swith to control if enable the feature heartbeat. optimize: used a shorter `user-agent` name. 2019-06-10 16:43:13 +08:00			`enable_heartbeat: true`
feature: implemented routes API for admin user, allowed user to manage route. (#79) * feature: supported to generate admin API basic configurations when the admin API is enabled. * feature: supported to manage route API for admin user, it contains: PUT, GET, DELETE and POST. * feature: used json schema to check if the request configuration is valid. 2019-06-13 12:01:36 +08:00			`enable_admin: true`
feature: supported debug mode. (#319) * feature: supported debug mode. print the plugin list which sort by priority. * feature: show the enabled plugin list in header for debug mode. 2019-07-27 09:10:06 +08:00			`enable_debug: false`
feature: support to match IPv6 request. (#341) * CLI: supported to listen IPv6. * feature: supported to match route by remote address. 2019-08-24 09:10:11 +08:00			`enable_ipv6: true`
feature: support to load routes from local yaml file. (#464) * feature: support to load routes from local yaml file. 2019-09-09 17:42:20 +08:00			`config_center: etcd # etcd: use etcd to store the config value`
			# yaml: fetch the config value from local yaml file `/your_path/conf/apisix.yaml`
change: if we don't set any IP list, then any IP access is allowed by default for admin API. 2019-08-29 15:55:13 +08:00			`# allow_admin: # http://nginx.org/en/docs/http/ngx_http_access_module.html#allow`
			`# - 127.0.0.0/24 # If we don't set any IP list, then any IP access is allowed by default.`
			`# - "::/64"`
feature: allowed to use different router. 2019-08-04 02:06:42 +08:00			`# port_admin: 9180 # use a separate port`
feature: supported real_ip configure in nginx.conf and added functions to get ip and remote ip. (#236) * feature: supported real_ip configure in nginx.conf and added functions to get ip and remote ip. * fixed code style. 2019-07-12 11:25:17 +08:00			`real_ip_header: "X-Real-IP" # http://nginx.org/en/docs/http/ngx_http_realip_module.html#real_ip_header`
			`real_ip_from: # http://nginx.org/en/docs/http/ngx_http_realip_module.html#set_real_ip_from`
			`- 127.0.0.1`
			`- 'unix:'`
feature: allowed to use different router. 2019-08-04 02:06:42 +08:00			`router:`
feature(router): implemented new SNI router `radixtree_sni`, and change (#418) * feature(router): implemented new SNI router `radixtree_sni`, and change default router to `radixtree_uri` and `radixtree_sni`. * optimize: avoided one lrucache call. 2019-08-20 13:03:25 +08:00			`http: 'radixtree_uri' # r3_uri: match route by uri(base on r3)`
doc(architecture): added new doc about `router`. 2019-08-04 09:54:30 +08:00			`# r3_host_uri: match route by host + uri(base on r3)`
feature: supported to use router `lua-resty-radixtree`. (#391) * feature: supported new router `lua-resty-radixtree`. * change(nginx.conf): sync from CLI. 2019-08-12 09:04:41 +08:00			`# radixtree_uri: match route by uri(base on radixtree)`
feature(router): implemented new SNI router `radixtree_sni`, and change (#418) * feature(router): implemented new SNI router `radixtree_sni`, and change default router to `radixtree_uri` and `radixtree_sni`. * optimize: avoided one lrucache call. 2019-08-20 13:03:25 +08:00
			`ssl: 'radixtree_sni' # r3_sni: match route by SNI(base on r3)`
			`# radixtree_sni: match route by SNI(base on radixtree)`
feature: support dynamic stream(TCP/UDP) proxy in apisix. (#501) * feature: support stream in apisix. * doc: added new feature in README. * CLI and added more doc. 2019-09-12 13:27:18 +08:00			`# stream_proxy: # TCP/UDP proxy`
			`# tcp: # TCP proxy port list`
			`# - 9100`
			`# - 9101`
			`# udp: # UDP proxy port list`
			`# - 9200`
			`# - 9211`
CLI: generated different nginx.conf for different OS. 2019-06-03 16:15:57 +08:00
feature: supported to load config from YAML config. 2019-04-11 16:53:21 +08:00			`etcd:`
feature: supported to use router `lua-resty-radixtree`. (#391) * feature: supported new router `lua-resty-radixtree`. * change(nginx.conf): sync from CLI. 2019-08-12 09:04:41 +08:00			`host: "http://127.0.0.1:2379" # etcd address`
			`prefix: "/apisix" # apisix configurations prefix`
			`timeout: 1 # 1 seconds`
change: added doc of how to load plugin. (#1) 2019-05-06 10:14:39 +08:00
feature: supported to use router `lua-resty-radixtree`. (#391) * feature: supported new router `lua-resty-radixtree`. * change(nginx.conf): sync from CLI. 2019-08-12 09:04:41 +08:00			`plugins: # plugin list`
change: used '###-##-###' as the name style of plugin. 2019-05-07 15:58:44 +08:00			`- example-plugin`
feature: implemented new feature `limit-req`. 2019-05-20 16:50:43 +08:00			`- limit-req`
feature: implemented plugin `limit-count`. 2019-05-21 11:17:46 +08:00			`- limit-count`
feature: supported zipkin plugin. (#304) 2019-07-26 17:16:31 +08:00			`- limit-conn`
feature: added `core.request` module. 2019-05-23 15:19:07 +08:00			`- key-auth`
feature: implemented plugin `prometheus`. 2019-05-24 22:38:40 +08:00			`- prometheus`
feature: supported to collect nginx status and pushed it to etcd. (#149) * feature: supported to collect nginx status and pushed it to etcd. * the return value of the exported api is the same as the other methods in the plugin. 2019-06-22 08:24:02 +08:00			`- node-status`
feature: supported JWT plugin and added test cases. 2019-07-24 16:59:37 +08:00			`- jwt-auth`
feature: supported zipkin plugin. (#304) 2019-07-26 17:16:31 +08:00			`- zipkin`
feature: added IPv4 whitelist/blacklist plugin `ip-restriction` (#398) 2019-08-19 13:59:47 +08:00			`- ip-restriction`
change: renamed plugin `grpc-proxy` to `grpc-transcode`. 2019-08-22 14:40:56 +08:00			`- grpc-transcode`
feature: added serverless plugins. (#86) 2019-08-26 10:37:36 +08:00			`- serverless-pre-function`
			`- serverless-post-function`
feature: implemented openid-connect plugin. (#447) 2019-08-30 19:49:45 +08:00			`- openid-connect`
feature: supported to added pluings to stream routes. (#513) * feature: supported to added pluings to stream routes. * feature: supported MQTT protocol. 2019-09-16 10:58:27 +08:00
			`stream_plugins:`
			`- mqtt-proxy`