kayx23 commented on code in PR #9611:
URL: https://github.com/apache/apisix/pull/9611#discussion_r1224137134
##########
conf/config-default.yaml:
##########
@@ -14,122 +14,121 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
-# PLEASE DO NOT UPDATE THIS FILE!
-# If you want to set the specified configuration value, you can set the new
-# value in the conf/config.yaml file.
+# CAUTION: DO NOT MODIFY DEFAULT CONFIGURATIONS IN THIS FILE.
+# Keep the custom configurations in conf/config.yaml.
#
apisix:
- # node_listen: 9080 # APISIX listening port
- node_listen: # This style support multiple ports
+ # node_listen: 9080 # APISIX listening port.
+ node_listen: # APISIX listening ports.
- 9080
- # - port: 9081
- # enable_http2: true # If not set, the default value is `false`.
- # - ip: 127.0.0.2 # Specific IP, If not set, the default
value is `0.0.0.0`.
- # port: 9082
- # enable_http2: true
- enable_admin: true
- enable_dev_mode: false # Sets nginx worker_processes to 1 if set
to true
- enable_reuseport: true # Enable nginx SO_REUSEPORT switch if set
to true.
- show_upstream_status_in_response_header: false # when true all upstream
status write to `X-APISIX-Upstream-Status` otherwise only 5xx code
+ # - port: 9081
+ # enable_http2: true # If not set, default to `false`.
+ # - ip: 127.0.0.2 # If not set, default to `0.0.0.0`/
+ # port: 9082
+ # enable_http2: true
+ enable_admin: true # Admin API
+ enable_dev_mode: false # If true, nginx worker_processes will be set
to 1.
+ enable_reuseport: true # If true, nginx SO_REUSEPORT option will be
enabled.
+ show_upstream_status_in_response_header: false # If true, include the
upstream HTTP status code in
+ # the response header
`X-APISIX-Upstream-Status`.
+ # If false, show
`X-APISIX-Upstream-Status` only if
+ # the upstream response code
is 5xx.
enable_ipv6: true
- #proxy_protocol: # Proxy Protocol configuration
- # listen_http_port: 9181 # The port with proxy protocol for http,
it differs from node_listen and admin_listen.
- # This port can only receive http request
with proxy protocol, but node_listen & admin_listen
- # can only receive http request. If you
enable proxy protocol, you must use this port to
- # receive http request with proxy protocol
- # listen_https_port: 9182 # The port with proxy protocol for https
- # enable_tcp_pp: true # Enable the proxy protocol for tcp proxy,
it works for stream_proxy.tcp option
- # enable_tcp_pp_to_upstream: true # Enables the proxy protocol to the
upstream server
- enable_server_tokens: true # Whether the APISIX version number should
be shown in Server header.
- # It's enabled by default.
-
- # configurations to load third party code and/or override the builtin one.
- extra_lua_path: "" # extend lua_package_path to load third
party code
- extra_lua_cpath: "" # extend lua_package_cpath to load third
party code
- #lua_module_hook: "my_project.my_hook" # the hook module which will be used
to inject third party code into APISIX
-
- proxy_cache: # Proxy Caching configuration
- cache_ttl: 10s # The default caching time in disk if the
upstream does not specify the cache time
- zones: # The parameters of a cache
- - name: disk_cache_one # The name of the cache, administrator can
specify
- # which cache to use by name in the admin
api (disk|memory)
- memory_size: 50m # The size of shared memory, it's used to
store the cache index for
- # disk strategy, store cache content for
memory strategy (disk|memory)
- disk_size: 1G # The size of disk, it's used to store the
cache data (disk)
- disk_path: /tmp/disk_cache_one # The path to store the cache data
(disk)
- cache_levels: 1:2 # The hierarchy levels of a cache (disk)
- #- name: disk_cache_two
+ # proxy_protocol: # PROXY Protocol configuration
+ # listen_http_port: 9181 # APISIX listening port for HTTP
traffic with PROXY protocol.
Review Comment:
Original comment is assuming people don't understand PROXY protocol and its
difference compared with other protocols (i.e. HTTP without PROXY protocol). I
kinda expect people looking for this config option understand this.
The `listen_http_port` option is already under `proxy_protocol` which to me
is pretty clear it's a port for HTTP and PROXY. I personally would not confuse
it with `node_listen` and such.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
