← Back
Editing: page-README.ri
U:RDoc::TopLevel[ i I" README:ETcRDoc::Parser::Simpleo:RDoc::Markup::Document: @parts[Mo: RDoc::Markup::Paragraph;[I"%lsapi - LSAPI extension for Ruby;TS:RDoc::Markup::Heading: leveli%: textI" ;To: RDoc::Markup::BlankLine o; ;[I" INSTALL;TS:RDoc::Markup::Rule: weighti @o:RDoc::Markup::Verbatim;[I" $ ruby setup.rb config ;TI"$ ruby setup.rb setup ;TI" # ruby setup.rb install ;T: @format0o; ;[I" USAGE;TS;;i@o; ;[ I"General CGI scripts ;TI"^^^^^^^^^^^^^^^^^^^ ;TI"SThe most efficient way to use LSAPI interface is to modify your CGI scripts. ;TI"<You need to add the following code to your CGI scripts:;T@o;;[ I"require 'lsapi' ;TI" ;TI" while LSAPI.accept != nil ;TI" ;TI" <your CGI script> ;TI" ... ;TI" ;TI" end ;T;0o; ;[I"LThere is no need to change the way that how CGI environment variables ;TI"(are being accessed in your scripts.;T@o; ;[I"7You can find some examples under examples/ folder.;T@o; ;[ I"Ruby Script Runner ;TI"^^^^^^^^^^^^^^^^^^ ;TI"OIf you don't want to change your existing Ruby CGI code, you can use our ;TI"FRuby script runner under scripts/ folder. You need to configure ;TI"Ilsruby_runner.rb as a LSAPI application, then add a script handler ;TI"for "rb" suffix.;T@@o; ;[I"Rails dispatcher ;TI"^^^^^^^^^^^^^^^^;T@o; ;[I"RWith Ruby LSAPI, we proudly provide a optimum platform for Rails application ;TI"Ndeployment. Ruby LSAPI has the following advantages over other solutions.;T@o;;[ I"M* Easy configuration, deploy a Rails application only take a few clicks ;TI") with our Rails easy configuration ;TI"M* Fast startup, the expensive Rails framework initialization only takes ;TI"= place once when multiple processes need to be started ;TI"J* Resource efficience, ruby processes can be started on demand, idle ;TI" process will be stop. ;T;0o; ;[I"DTo use LSAPI with Ruby on Rails, please check out our toturial ;TI"7http://www.litespeedtech.com/support/wiki/doku.php;T@o; ;[I"MThere are a few environment variables that can be tweaked to tune ruby ;TI"LSAPI process.;T@o:RDoc::Markup::List: @type: BULLET: @items[o:RDoc::Markup::ListItem: @label0;[o; ;[I"/LSAPI_CHILDREN (default: 0);T@o; ;[ I"MLSAPI_CHILDREN controls the maximum number of children processes can be ;TI"Ostarted by the first ruby process started by web server. When set to <=1, ;TI"Pthe first ruby process will handle request by itself, without starting any ;TI"Rchild process. When LSAPI_CHILDREN is >1, the LSAPI application is stared in ;TI"O"Self Managed Mode", which will start children processes based on demand. ;TI"JWith Rails easy configuration, LSAPI_CHILDREN is set to the value of ;TI"C"Max Connections" by web server, no need to set it explicitly.;T@o; ;[I"OUsually, there is no need to set value of LSAPI_CHILDREN over 100 in most ;TI"server environment.;T@o;;;;[o;;0;[o; ;[I"/LSAPI_AVOID_FORK (default: 0);T@o; ;[ I"NLSAPI_AVOID_FORK specifies the policy of the internal process manager in ;TI"P"Self Managed Mode". When set to 0, the internal process manager will stop ;TI"Kand start children process on demand to save system resource. This is ;TI"Lpreferred in a shared hosting environment. When set to 1, the internal ;TI"Pprocess manager will try to avoid freqently stopping and starting children ;TI"Hprocess. This might be preferred in a dedicate hosting environment.;T@o;;;;[o;;0;[o; ;[I"HLSAPI_EXTRA_CHILDREN (default: 1/3 of LSAPI_CHILDREN or 0);T@o; ;[ I"RLSAPI_EXTRA_CHILDREN controls the maximum number of extra children processes ;TI"Hcan be started when some or all existing children processes are in ;TI"Qmalfunctioning state. Total number of children processes will be reduced to ;TI"@LSAPI_CHILDREN level as soon as service is back to normal. ;TI"DWhen LSAPI_AVOID_FORK is set to 0, the default value is 1/3 of ;TI"OLSAPI_CHIDLREN, When LSAPI_AVOID_FORK is set to 1, the default value is 0.;T@o;;;;[o;;0;[o; ;[I"9LSAPI_MAX_REQS (default value: 10000);T@o; ;[I"HLSAPI_MAX_REQS specifies the maximum number of requests each child ;TI"Kprocess will handle before it exits automatically. This parameter can ;TI"Phelp reducing memory usage when there are memory leaks in the application. ;T@o;;;;[o;;0;[o; ;[I"?LSAPI_MAX_IDLE (default value: 300 seconds);T@o; ;[I"HIn Self Managed Mode, LSAPI_MAX_IDLE controls how long a idle child;T@o; ;[I"Hprocess will wait for a new request before exit. This option help ;TI"8releasing system resources taken by idle processes.;T@o;;;;[o;;0;[o; ;[I" LSAPI_MAX_IDLE_CHILDREN;To;;[I">(default value: 1/3 of LSAPI_CHILDREN or LSAPI_CHILDREN) ;T;0o; ;[ I"JIn Self Managed Mode, LSAI_MAX_IDLE_CHILDREN controls how many idle ;TI"Gchildren processes are allowed. Excessive idle children processes ;TI"+will be killed by the parent process. ;TI"DWhen LSAPI_AVOID_FORK is set to 0, the default value is 1/3 of ;TI"JLSAPI_CHIDLREN, When LSAPI_AVOID_FORK is set to 1, the default value ;TI"is LSAPI_CHILDREN.;T@o;;;;[o;;0;[o; ;[I"?LSAPI_MAX_PROCESS_TIME (default value: 300 seconds);T@o; ;[ I"HIn Self Managed Mode, LSAPI_MAX_PROCESS_TIME controls the maximum ;TI"Kprocessing time allowed when processing a request. If a child process ;TI"Jcan not finish processing of a request in the given time period, it ;TI"Mwill be killed by the parent process. This option can help getting rid ;TI"&of dead or runaway child process.;T@o;;;;[o;;0;[o; ;[I"<LSAPI_PGRP_MAX_IDLE (default value: FOREVER );T@o; ;[ I"LIn Self Managed Mode, LSAPI_PGRP_MAX_IDLE controls how long the parent ;TI"Fprocess will wait before exiting when there is no child process. ;TI"JThis option help releasing system resources taken by an idle parent ;TI" process.;T@o;;;;[o;;0;[o; ;[I"LSAPI_PPID_NO_CHECK;T@o; ;[ I"NBy default a LSAPI application check the existence of its parent process ;TI"Land exits automatically if the parent process died. This is to reduce ;TI"Morphan process when web server is restarted. However, it is desireable ;TI"Hto disable this feature, such as when a LSAPI process was started ;TI"Imanually from command line. LSAPI_PPID_NO_CHECK should be set when ;TI"Eyou want to disable the checking of existence of parent process.;T@o; ;[I" License;TS;;i @o; ;[I",LSAPI library code is under BSD license;T@o; ;[I"4LSAPI ruby extension code is under Ruby license;T@o;;;;[o;;0;[o; ;[I"A((<URL:http://www.ruby-lang.org/ja/LICENSE.txt>)) (Japanese);To;;0;[o; ;[I"@((<URL:http://www.ruby-lang.org/en/LICENSE.txt>)) (English);T@o; ;[I"Copyright;TS;;i @o; ;[I"4Copyright (C) 2006 Lite Speed Technologies Inc.;T: @file@:0@omit_headings_from_table_of_contents_below0
Save File
Cancel