| --- |
| title: proxy-control |
| --- |
| |
| <!-- |
| # |
| # Licensed to the Apache Software Foundation (ASF) under one or more |
| # contributor license agreements. See the NOTICE file distributed with |
| # this work for additional information regarding copyright ownership. |
| # The ASF licenses this file to You under the Apache License, Version 2.0 |
| # (the "License"); you may not use this file except in compliance with |
| # the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # |
| --> |
| |
| ## Description |
| |
| The `proxy-control` plugin dynamically controls the behavior of Nginx to proxy. |
| |
| **This plugin requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment?).** |
| |
| ## Attributes |
| |
| | Name | Type | Requirement | Default | Valid | Description | |
| | --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | |
| | request_buffering | boolean | optional | true | | dynamically set the `proxy_request_buffering` directive | |
| |
| ## How To Enable |
| |
| Here's an example, enable this plugin on the specified route: |
| |
| ```shell |
| curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' |
| { |
| "uri": "/upload", |
| "plugins": { |
| "proxy-control": { |
| "request_buffering": false |
| } |
| }, |
| "upstream": { |
| "type": "roundrobin", |
| "nodes": { |
| "127.0.0.1:1980": 1 |
| } |
| } |
| }' |
| ``` |
| |
| ## Test Plugin |
| |
| Use curl to access: |
| |
| ```shell |
| curl -i http://127.0.0.1:9080/upload -d @very_big_file |
| ``` |
| |
| It's expected not to find "a client request body is buffered to a temporary file" in the error log. |
| |
| ## Disable Plugin |
| |
| When you want to disable this plugin, it is very simple, |
| you can delete the corresponding json configuration in the plugin configuration, |
| no need to restart the service, it will take effect immediately: |
| |
| ```shell |
| curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' |
| { |
| "uri": "/upload", |
| "upstream": { |
| "type": "roundrobin", |
| "nodes": { |
| "127.0.0.1:1980": 1 |
| } |
| } |
| }' |
| ``` |
| |
| This plugin has been disabled now. It works for other plugins. |