https://github.com/vozlt/nginx-module-udc
Nginx module to compare the value of user-defined variables and request.
https://github.com/vozlt/nginx-module-udc
c example-code nginx nginx-module vozlt-nginx-modules
Last synced: 3 months ago
JSON representation
Nginx module to compare the value of user-defined variables and request.
- Host: GitHub
- URL: https://github.com/vozlt/nginx-module-udc
- Owner: vozlt
- License: bsd-2-clause
- Created: 2015-01-08T16:14:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-21T08:39:52.000Z (over 8 years ago)
- Last Synced: 2025-06-05T07:25:32.776Z (4 months ago)
- Topics: c, example-code, nginx, nginx-module, vozlt-nginx-modules
- Language: C
- Size: 7.81 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Nginx module to compare the value of user-defined variables and request.(test module)
==========
[](https://github.com/vozlt/nginx-module-udc/blob/master/LICENSE)
This is my first nginx test module for understanding nginx module development.
A nginx module to compare the value of user-defined variables and request.
## Dependencies
* nginx
## Compatibility
* 1.7.x (last tested: 1.7.8)
* 1.6.x (last tested: 1.6.2)
Earlier versions is not tested.
## Installation
1. Clone the git repository.
```
shell> git clone git://github.com/vozlt/nginx-module-udc.git
```
2. Add the module to the build configuration by adding
`--add-module=/path/to/nginx-module-udc`
3. Build the nginx binary.
4. Install the nginx binary.
## Synopsis
```Nginx
location /user-define-check {
user_define_check;
user_define_check_out_type json;
user_define_check_allow_text "true";
user_define_check_deny_text "false";
user_define_check_agent "USER_DEFINED_0";
user_define_check_agent "USER_DEFINED_1";
user_define_check_agent "USER_DEFINED_2";
}
```
## Description
This is an Nginx module that compare the value of user-defined variables and value of request.
This module returns the compared result to string that is specific type.
The types as follows:
* JSON
* TEXT
## Directives
### user_define_check
| - | - |
| --- | --- |
| **Syntax** | user_define_check |
| **Default** | - |
| **Context** | server, location |
Description: Enables or disables user_define_check function.
### user_define_check_out_type
| - | - |
| --- | --- |
| **Syntax** | user_define_check_out_type [json\|text] |
| **Default** | json |
| **Context** | server, location |
Description: The output type of result.
### user_define_check_allow_text
| - | - |
| --- | --- |
| **Syntax** | user_define_check_allow_text <*user-defined-string*> |
| **Default** | true |
| **Context** | server, location |
Description: The string of success result.
### user_define_check_deny_text
| - | - |
| --- | --- |
| **Syntax** | user_define_check_deny_text <*user-defined-string*> |
| **Default** | false |
| **Context** | server, location |
Description: The string of failure result.
### user_define_check_agent
| - | - |
| --- | --- |
| **Syntax** | user_define_check_agent <*user-defined-string*> |
| **Default** | - |
| **Context** | server, location |
Description: The string to check.
## Testing
```
shell> (echo -en "GET /user-define-check?USER_DEFINED_0 HTTP/1.1\r\nHost:localhost\r\n\r\n"; sleep 1) | nc localhost 80
```
```
{"status":"true"}
```
```
shell> (echo -en "GET /user-define-check?USER_DEFINED_3 HTTP/1.1\r\nHost:localhost\r\n\r\n"; sleep 1) | nc localhost 80
```
```
{"status":"false"}
```
## Author
YoungJoo.Kim []