{"id":13635886,"url":"https://github.com/calio/form-input-nginx-module","last_synced_at":"2025-07-12T01:31:30.531Z","repository":{"id":870167,"uuid":"609888","full_name":"calio/form-input-nginx-module","owner":"calio","description":"This is a nginx module that reads HTTP POST and PUT request body encoded     in \"application/x-www-form-urlencoded\", and parse the arguments in     request body into nginx variables.","archived":false,"fork":false,"pushed_at":"2017-10-27T20:55:33.000Z","size":181,"stargazers_count":118,"open_issues_count":2,"forks_count":36,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-02-13T10:04:24.340Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/calio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-04-14T10:50:36.000Z","updated_at":"2023-11-28T11:52:19.000Z","dependencies_parsed_at":"2022-08-08T09:15:09.872Z","dependency_job_id":null,"html_url":"https://github.com/calio/form-input-nginx-module","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/calio/form-input-nginx-module","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calio%2Fform-input-nginx-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calio%2Fform-input-nginx-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calio%2Fform-input-nginx-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calio%2Fform-input-nginx-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/calio","download_url":"https://codeload.github.com/calio/form-input-nginx-module/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calio%2Fform-input-nginx-module/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264923080,"owners_count":23683716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T00:00:53.719Z","updated_at":"2025-07-12T01:31:30.145Z","avatar_url":"https://github.com/calio.png","language":"Perl","funding_links":[],"categories":["Modules","Third Modules","Third Party Modules","Variables, JSON and extensibility"],"sub_categories":["C Modules"],"readme":"Name\n====\n\nform-input-nginx-module - NGINX module that reads HTTP POST and PUT request body encoded in \"application/x-www-form-urlencoded\" and parses the arguments into nginx variables.\n\nTable of Contents\n=================\n\n* [Name](#name)\n* [Description](#description)\n* [Installation](#installation)\n    * [Building as a dynamic module](#building-as-a-dynamic-module)\n* [Usage](#usage)\n* [Limitations](#limitations)\n* [Compatibility](#compatibility)\n* [Copyright \u0026 License](#copyright--license)\n\nDescription\n===========\n\nThis is a nginx module that reads HTTP POST and PUT request body encoded\nin \"application/x-www-form-urlencoded\", and parse the arguments in\nrequest body into nginx variables.\n\nThis module depends on the ngx_devel_kit (NDK) module.\n\nInstallation\n============\n\nGrab the nginx source code from [nginx.org](http://nginx.org/), for example,\nthe version 1.9.15 (see [nginx compatibility](#compatibility)), and then build the source with this module:\n\n```bash\nwget 'http://nginx.org/download/nginx-1.9.15.tar.gz'\ntar -xzvf nginx-1.9.15.tar.gz\ncd nginx-1.9.15/\n\n./configure --add-module=/path/to/ngx_devel_kit \\\n    --add-module=/path/to/form-input-nginx-module\n\nmake -j2\nmake install\n```\n\nDownload the latest version of the release tarball of this module from [form-input-nginx-module file list](http://github.com/calio/form-input-nginx-module/tags), and the latest tarball for [ngx_devel_kit](https://github.com/simpl/ngx_devel_kit) from its [file list](https://github.com/simpl/ngx_devel_kit/tags).\n\nBuilding as a dynamic module\n----------------------------\n\nStarting from NGINX 1.9.11, you can also compile this module as a dynamic module, by using the `--add-dynamic-module=PATH` option instead of `--add-module=PATH` on the\n`./configure` command line above. And then you can explicitly load the module in your `nginx.conf` via the [load_module](http://nginx.org/en/docs/ngx_core_module.html#load_module)\ndirective, for example,\n\n```nginx\nload_module /path/to/modules/ndk_http_module.so;  # assuming NDK is built as a dynamic module too\nload_module /path/to/modules/ngx_http_form_input_module.so;\n```\n\n[Back to TOC](#table-of-contents)\n\nUsage\n=====\n\n```nginx\nset_form_input $variable;\nset_form_input $variable argument;\n\nset_form_input_multi $variable;\nset_form_input_multi $variable argument;\n```\n\nexample:\n\n```nginx\n#nginx.conf\n\nlocation /foo {\n    # ensure client_max_body_size == client_body_buffer_size\n    client_max_body_size 100k;\n    client_body_buffer_size 100k;\n\n    set_form_input $data;    # read \"data\" field into $data\n    set_form_input $foo foo; # read \"foo\" field into $foo\n}\n\nlocation /bar {\n    # ensure client_max_body_size == client_body_buffer_size\n    client_max_body_size 1m;\n    client_body_buffer_size 1m;\n\n    set_form_input_multi $data; # read all \"data\" field into $data\n    set_form_input_multi $foo data; # read all \"data\" field into $foo\n\n    array_join ' ' $data; # now $data is an string\n    array_join ' ' $foo;  # now $foo is an string\n}\n```\n\n[Back to TOC](#table-of-contents)\n\nLimitations\n===========\n\n* ngx_form_input will discard request bodies that are buffered\nto disk files. When the client_max_body_size setting is larger than\nclient_body_buffer_size, request bodies that are larger\nthan client_body_buffer_size (but no larger than\nclient_max_body_size) will be buffered to disk files.\nSo it's important to ensure these two config settings take\nthe same values to avoid confustion.\n\n[Back to TOC](#table-of-contents)\n\nCompatibility\n=============\n\nThe following versions of Nginx should work with this module:\n\n* 1.9.x (last tested: 1.9.15)\n* 1.8.x\n* 1.7.x (last tested: 1.7.4)\n* 1.6.x\n* 1.5.x (last tested: 1.5.12)\n* 1.4.x (last tested: 1.4.6)\n* 1.1.x (last tested: 1.1.5)\n* 1.0.x (last tested: 1.0.8)\n* 0.9.x (last tested: 0.9.4)\n* 0.8.x \u003e= 0.8.54\n\n[Back to TOC](#table-of-contents)\n\nCopyright \u0026 License\n===================\n\nCopyright (c) 2010, 2011, Jiale \"calio\" Zhi \u003cvipcalio@gmail.com\u003e.\n\nCopyright (c) 2010-2016, Yichun \"agentzh\" Zhang \u003cagentzh@gmail.com\u003e, CloudFlare Inc.\n\nThis module is licensed under the terms of the BSD license.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n\n* Redistributions of source code must retain the above copyright\nnotice, this list of conditions and the following disclaimer.\n* Redistributions in binary form must reproduce the above copyright\nnotice, this list of conditions and the following disclaimer in the\ndocumentation and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS\nIS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED\nTO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A\nPARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\nHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\nSPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED\nTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n[Back to TOC](#table-of-contents)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalio%2Fform-input-nginx-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcalio%2Fform-input-nginx-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalio%2Fform-input-nginx-module/lists"}