Skip to content
This repository
Browse code

documented ngx.HTTP_GATEWAY_TIMEOUT and also included edits from Ngin…

…x User.
  • Loading branch information...
commit ea24c93c8263aff2b64c68a13433460f03bf711b 1 parent f88d229
Yichun Zhang authored December 02, 2011
25  README
@@ -8,9 +8,9 @@ Status
8 8
     This module is under active development and is production ready.
9 9
 
10 10
 Version
11  
-    This document describes ngx_lua v0.3.1rc37
12  
-    (<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 29
13  
-    November 2011.
  11
+    This document describes ngx_lua v0.3.1rc38
  12
+    (<https://github.com/chaoslawful/lua-nginx-module/tags>) released on 2
  13
+    December 2011.
14 14
 
15 15
 Synopsis
16 16
         # set search paths for pure Lua external libraries (';;' is the default path):
@@ -381,9 +381,9 @@ Directives
381 381
     Same as content_by_lua, except the code to be executed is in the file
382 382
     specified by "<path-lua-script>".
383 383
 
384  
-    Nginx variables can be used in "<path-to-lua-script>" string, in order
385  
-    to provide greater flexibility in practice. This however carries some
386  
-    risks and is not ordinarily recommended.
  384
+    Nginx variables can be used in "<path-to-lua-script>" string to provide
  385
+    flexibility. This however carries some risks and is not ordinarily
  386
+    recommended.
387 387
 
388 388
     When the Lua code cache is on (default state), the user code is loaded
389 389
     once at the first request and cached and the Nginx config must be
@@ -523,9 +523,9 @@ Directives
523 523
     Same as rewrite_by_lua, except the code to be executed is in the file
524 524
     specified by "<path-lua-script>".
525 525
 
526  
-    Nginx variables can be used in "<path-to-lua-script>" string, in order
527  
-    to provide greater flexibility in practice. This however carries some
528  
-    risks and is not ordinarily recommended.
  526
+    Nginx variables can be used in "<path-to-lua-script>" string to provide
  527
+    flexibility. This however carries some risks and is not ordinarily
  528
+    recommended.
529 529
 
530 530
     When the Lua code cache is on (default state), the user code is loaded
531 531
     once at the first request and cached and the Nginx config must be
@@ -618,9 +618,9 @@ Directives
618 618
     Same as access_by_lua, except the code to be executed is in the file
619 619
     specified by "<path-lua-script>".
620 620
 
621  
-    Nginx variables can be used in "<path-to-lua-script>" string, in order
622  
-    to provide greater flexibility in practice. This however carries some
623  
-    risks and is not ordinarily recommended.
  621
+    Nginx variables can be used in "<path-to-lua-script>" string to provide
  622
+    flexibility. This however carries some risks and is not ordinarily
  623
+    recommended.
624 624
 
625 625
     When the Lua code cache is on (default state), the user code is loaded
626 626
     once at the first request and cached and the Nginx config must be
@@ -868,6 +868,7 @@ Nginx API for Lua
868 868
       value = ngx.HTTP_INTERNAL_SERVER_ERROR (500)
869 869
       value = ngx.HTTP_METHOD_NOT_IMPLEMENTED (501)
870 870
       value = ngx.HTTP_SERVICE_UNAVAILABLE (503)
  871
+      value = ngx.HTTP_GATEWAY_TIMEOUT (504) (first added in the v0.3.1rc38 release)
871 872
 
872 873
   Nginx log level constants
873 874
     context: *set_by_lua*, rewrite_by_lua*, access_by_lua*, content_by_lua*,
11  README.markdown
Source Rendered
@@ -13,7 +13,7 @@ This module is under active development and is production ready.
13 13
 Version
14 14
 =======
15 15
 
16  
-This document describes ngx_lua [v0.3.1rc37](https://github.com/chaoslawful/lua-nginx-module/tags) released on 29 November 2011.
  16
+This document describes ngx_lua [v0.3.1rc38](https://github.com/chaoslawful/lua-nginx-module/tags) released on 2 December 2011.
17 17
 
18 18
 Synopsis
19 19
 ========
@@ -384,8 +384,7 @@ content_by_lua_file
384 384
 Same as [content_by_lua](http://wiki.nginx.org/HttpLuaModule#content_by_lua), except the code to be executed is in the file
385 385
 specified by `<path-lua-script>`.
386 386
 
387  
-Nginx variables can be used in `<path-to-lua-script>` string, in order to provide
388  
-greater flexibility in practice. This however carries some risks and is not ordinarily recommended.
  387
+Nginx variables can be used in `<path-to-lua-script>` string to provide flexibility. This however carries some risks and is not ordinarily recommended. 
389 388
 
390 389
 When the Lua code cache is on (default state), the user code is loaded once at the first request and cached 
391 390
 and the Nginx config must be reloaded each time you modify the lua code file.
@@ -518,7 +517,7 @@ rewrite_by_lua_file
518 517
 
519 518
 Same as [rewrite_by_lua](http://wiki.nginx.org/HttpLuaModule#rewrite_by_lua), except the code to be executed is in the file specified by `<path-lua-script>`.
520 519
 
521  
-Nginx variables can be used in `<path-to-lua-script>` string, in order to provide greater flexibility in practice. This however carries some risks and is not ordinarily recommended. 
  520
+Nginx variables can be used in `<path-to-lua-script>` string to provide flexibility. This however carries some risks and is not ordinarily recommended. 
522 521
 
523 522
 When the Lua code cache is on (default state), the user code is loaded once at the first request and cached and the Nginx config must be reloaded each time you modify the Lua source file. You can temporarily disable the Lua code cache during development by switching [lua_code_cache](http://wiki.nginx.org/HttpLuaModule#lua_code_cache) `off` in your `nginx.conf` to avoid reloading Nginx.
524 523
 
@@ -603,8 +602,7 @@ access_by_lua_file
603 602
 Same as [access_by_lua](http://wiki.nginx.org/HttpLuaModule#access_by_lua), except the code to be executed is in the file
604 603
 specified by `<path-lua-script>`.
605 604
 
606  
-Nginx variables can be used in `<path-to-lua-script>` string, in order to provide
607  
-greater flexibility in practice. This however carries some risks and is not ordinarily recommended.
  605
+Nginx variables can be used in `<path-to-lua-script>` string to provide flexibility. This however carries some risks and is not ordinarily recommended. 
608 606
 
609 607
 When the Lua code cache is on (default state), the user code is loaded once at the first request and cached 
610 608
 and the Nginx config must be reloaded each time you modify the lua code file.
@@ -850,6 +848,7 @@ HTTP status constants
850 848
       value = ngx.HTTP_INTERNAL_SERVER_ERROR (500)
851 849
       value = ngx.HTTP_METHOD_NOT_IMPLEMENTED (501)
852 850
       value = ngx.HTTP_SERVICE_UNAVAILABLE (503)
  851
+      value = ngx.HTTP_GATEWAY_TIMEOUT (504) (first added in the v0.3.1rc38 release)
853 852
 
854 853
 
855 854
 Nginx log level constants
11  doc/HttpLuaModule.wiki
Source Rendered
@@ -10,7 +10,7 @@ This module is under active development and is production ready.
10 10
 
11 11
 = Version =
12 12
 
13  
-This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.3.1rc37] released on 29 November 2011.
  13
+This document describes ngx_lua [https://github.com/chaoslawful/lua-nginx-module/tags v0.3.1rc38] released on 2 December 2011.
14 14
 
15 15
 = Synopsis =
16 16
 <geshi lang="nginx">
@@ -370,8 +370,7 @@ Do not use this directive and other content handler directives in a same locatio
370 370
 Same as [[#content_by_lua|content_by_lua]], except the code to be executed is in the file
371 371
 specified by <code><path-lua-script></code>.
372 372
 
373  
-Nginx variables can be used in <code><path-to-lua-script></code> string, in order to provide
374  
-greater flexibility in practice. This however carries some risks and is not ordinarily recommended.
  373
+Nginx variables can be used in <code><path-to-lua-script></code> string to provide flexibility. This however carries some risks and is not ordinarily recommended. 
375 374
 
376 375
 When the Lua code cache is on (default state), the user code is loaded once at the first request and cached 
377 376
 and the Nginx config must be reloaded each time you modify the lua code file.
@@ -502,7 +501,7 @@ Here the Lua code <code>ngx.exit(503)</code> will never run. This will be the ca
502 501
 
503 502
 Same as [[#rewrite_by_lua|rewrite_by_lua]], except the code to be executed is in the file specified by <code><path-lua-script></code>.
504 503
 
505  
-Nginx variables can be used in <code><path-to-lua-script></code> string, in order to provide greater flexibility in practice. This however carries some risks and is not ordinarily recommended. 
  504
+Nginx variables can be used in <code><path-to-lua-script></code> string to provide flexibility. This however carries some risks and is not ordinarily recommended. 
506 505
 
507 506
 When the Lua code cache is on (default state), the user code is loaded once at the first request and cached and the Nginx config must be reloaded each time you modify the Lua source file. You can temporarily disable the Lua code cache during development by switching [[#lua_code_cache|lua_code_cache]] <code>off</code> in your <code>nginx.conf</code> to avoid reloading Nginx.
508 507
 
@@ -585,8 +584,7 @@ Note that when calling <code>ngx.exit(ngx.OK)</code> within a [[#access_by_lua|a
585 584
 Same as [[#access_by_lua|access_by_lua]], except the code to be executed is in the file
586 585
 specified by <code><path-lua-script></code>.
587 586
 
588  
-Nginx variables can be used in <code><path-to-lua-script></code> string, in order to provide
589  
-greater flexibility in practice. This however carries some risks and is not ordinarily recommended.
  587
+Nginx variables can be used in <code><path-to-lua-script></code> string to provide flexibility. This however carries some risks and is not ordinarily recommended. 
590 588
 
591 589
 When the Lua code cache is on (default state), the user code is loaded once at the first request and cached 
592 590
 and the Nginx config must be reloaded each time you modify the lua code file.
@@ -821,6 +819,7 @@ These constants are usually used in [[#ngx.location.capture|ngx.location.catpure
821 819
   value = ngx.HTTP_INTERNAL_SERVER_ERROR (500)
822 820
   value = ngx.HTTP_METHOD_NOT_IMPLEMENTED (501)
823 821
   value = ngx.HTTP_SERVICE_UNAVAILABLE (503)
  822
+  value = ngx.HTTP_GATEWAY_TIMEOUT (504) (first added in the v0.3.1rc38 release)
824 823
 </geshi>
825 824
 
826 825
 == Nginx log level constants ==

0 notes on commit ea24c93

Please sign in to comment.
Something went wrong with that request. Please try again.