Skip to content

Commit 5dd80fd

Browse files
authored
Update README.md
links to files, docker info and small textural modifications
1 parent 553356f commit 5dd80fd

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

Examples/Nginx/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66

77
## Implementation
88

9-
Copy `KnownUserNginxHandler.lua` and folders (`SDK` and `Helpers`) incl. their content to your NGINX filesystem (in the following example we have added it to `usr/queueit`).
9+
NOTE: The following implementation steps have been developed and tested using this [Docker image](https://github.com/fabiocicerchia/nginx-lua).
10+
11+
Copy [KnownUserNginxHandler.lua](https://github.com/queueit/KnownUser.V3.Lua/blob/master/Handlers/KnownUserNginxHandler.lua) and folders ([SDK](https://github.com/queueit/KnownUser.V3.Lua/tree/master/SDK) and [Helpers](https://github.com/queueit/KnownUser.V3.Lua/tree/master/Helpers)) incl. their content to your NGINX filesystem (in the following example we have added it to `usr/queueit`).
1012

1113
Then update/add `lua_package_path` in your `nginx.conf` to include the new path (keep `;;` in the end which means default path):
1214

@@ -45,7 +47,7 @@ server {
4547
```
4648
In this example `rewrite_by_lua_block` have been added to default location `\` but you must decide what makes sense in your case.
4749

48-
Please note the comments in the code below about providing `integrationconfig.json` and replace `CUSTOMER_ID` and `SECRET_KEY` with correct credentials found in GO Queue-it platform.
50+
Please note the comments in the code about providing `integrationconfig.json` and replacing `CUSTOMER_ID` and `SECRET_KEY` with correct credentials located in GO Queue-it platform.
4951

5052
### Request body trigger (advanced)
5153
Nginx handler (incl. Lua SDK) supports triggering on request body content. Example could be a POST call with specific item ID where you want end-users to queue up for.
@@ -55,8 +57,11 @@ When enabled you also need to add extra settings to `location` in `conf.d/defaul
5557
```
5658
location / {
5759
...
58-
lua_need_request_body on; # enabling reading of request body
59-
client_body_buffer_size 64k; # ensure large buffer for requst body (PLEASE DECIDE WHAT BUFFER SIZE IS RELEVANT IN YOUR CASE)
60+
# enabling reading of request body
61+
lua_need_request_body on;
62+
63+
# ensure large buffer for requst body (PLEASE DECIDE WHAT BUFFER SIZE IS RELEVANT IN YOUR CASE)
64+
client_body_buffer_size 64k;
6065
...
6166
}
6267
```

0 commit comments

Comments
 (0)