mirror of
https://github.com/usmannasir/cyberpanel.git
synced 2026-01-28 10:19:04 +01:00
108 lines
18 KiB
HTML
108 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
|
<title>OpenLiteSpeed Users' Manual - Rack/Rails Settings</title>
|
|
<meta name="description" content="OpenLiteSpeed Users' Manual - Rack/Rails Settings." />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<link rel="shortcut icon" href="img/favicon.ico" />
|
|
<link rel="stylesheet" type="text/css" href="css/hdoc.css">
|
|
</head>
|
|
<body>
|
|
<div class="pagewrapper clearfix"><aside class="sidetree ls-col-1-5">
|
|
<figure>
|
|
<img src="img/ols_logo.svg" alt="openlitespeed logo" width="150px"/>
|
|
</figure>
|
|
<h3 class="ls-text-thin">OpenLiteSpeed Web Server <a href="index.html"> Users' Manual</a></h3>
|
|
<h5 class="ls-text-muted">Version 1.4 — Rev. 6</h5>
|
|
<hr/>
|
|
<div>
|
|
<ul>
|
|
<li><a href="license.html">License</a></li>
|
|
<li><a href="intro.html">Introduction</a></li>
|
|
<li><a href="install.html">Installation</a></li>
|
|
<li><a href="admin.html">Administration</a>
|
|
<ul class="level2"><li><a href="ServerStat_Help.html">Service Manager</a></li></ul></li>
|
|
<li><a href="security.html">Security</a></li>
|
|
<li><a href="config.html">Configuration</a>
|
|
<ul class="level2">
|
|
<li><a href="ServGeneral_Help.html">Server General</a></li>
|
|
<li><a href="ServLog_Help.html">Server Log</a></li>
|
|
<li><a href="ServTuning_Help.html">Server Tuning</a></li>
|
|
<li><a href="ServSecurity_Help.html">Server Security</a></li>
|
|
<li><a href="ExtApp_Help.html">External Apps</a></li>
|
|
<ul class="level3">
|
|
<li><a href="External_FCGI.html">Fast CGI App</a></li>
|
|
<li><a href="External_FCGI_Auth.html">Fast CGI Authorizer</a></li>
|
|
<li><a href="External_LSAPI.html">LSAPI App</a></li>
|
|
<li><a href="External_Servlet.html">Servlet Engine</a></li>
|
|
<li><a href="External_WS.html">Web Server</a></li>
|
|
<li><a href="External_PL.html">Piped logger</a></li>
|
|
<li><a href="External_LB.html">Load Balancer</a></li>
|
|
</ul>
|
|
<li><a href="ScriptHandler_Help.html">Script Handler</a></li>
|
|
<li><span class="current"><a href="Rails_Help.html">Rack/Rails Settings</a></span></li>
|
|
<li><a href="Module_Help.html">Module Configuration</a></li>
|
|
<li><a href="Listeners_General_Help.html">Listener General</a></li>
|
|
<li><a href="Listeners_SSL_Help.html">Listener SSL</a></li>
|
|
<li><a href="Templates_Help.html">Templates</a></li>
|
|
<li><a href="VirtualHosts_Help.html">Virtual Host Basic</a></li>
|
|
<li><a href="VHGeneral_Help.html">Virtual Host General</a></li>
|
|
<li><a href="VHSecurity_Help.html">Virtual Host Security</a></li>
|
|
<li><a href="VHSSL_Help.html">Virtual Host SSL</a></li>
|
|
<li><a href="Rewrite_Help.html">Rewrite</a></li>
|
|
<li><a href="Context_Help.html">Context</a></li>
|
|
<ul class="level3">
|
|
<li><a href="Static_Context.html">Static Context</a></li>
|
|
<li><a href="Java_Web_App_Context.html">Java Web App Context</a></li>
|
|
<li><a href="Servlet_Context.html">Servlet Context</a></li>
|
|
<li><a href="FCGI_Context.html">Fast CGI Context</a></li>
|
|
<li><a href="LSAPI_Context.html">LSAPI Context</a></li>
|
|
<li><a href="Proxy_Context.html">Proxy Context</a></li>
|
|
<li><a href="CGI_Context.html">CGI Context</a></li>
|
|
<li><a href="LB_Context.html">Load Balancer Context</a></li>
|
|
<li><a href="Redirect_Context.html">Redirect Context</a></li>
|
|
<li><a href="Rails_Context.html">Rack/Rails Context</a></li>
|
|
<li><a href="Module_Context.html">Module Handler Context</a></li>
|
|
</ul>
|
|
<li><a href="VHWebSocket_Help.html">Web Socket Proxy</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="webconsole.html">Web Console</a>
|
|
<ul class="level2">
|
|
<li><a href="AdminGeneral_Help.html">Admin Console General</a></li>
|
|
<li><a href="AdminSecurity_Help.html">Admin Console Security</a></li>
|
|
<li><a href="AdminListeners_General_Help.html">Admin Listener General</a></li>
|
|
<li><a href="AdminListeners_SSL_Help.html">Admin Listener SSL</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</aside>
|
|
<article class="contentwrapper ls-col-3-5 clearfix"><div class="nav-bar ls-spacer-micro-top"><div class="prev">« <a href="ScriptHandler_Help.html">Script Handler</a></div><div class="center"><a href="config.html">Configuration</a></div><div class="next"><a href="Module_Help.html">Module Configuration</a> »</div></div>
|
|
<h1>Rack/Rails Settings</h1><h2 id="top">Table of Contents</h2><section class="toc"><section class="toc-row"><header><a href="#railsDefault">Ruby Rack/Rails Settings</a></header><p>
|
|
<a href="#rubyBin">Ruby Path</a> | <a href="#railsEnv">Run-Time Mode</a> | <a href="#maxConns">Max Connections</a> | <a href="#env">Environment</a> | <a href="#initTimeout">Initial Request Timeout (secs)</a> | <a href="#retryTimeout">Retry Timeout (secs)</a> | <a href="#pcKeepAliveTimeout">Keep Alive Timeout (secs)</a> | <a href="#respBuffer">Response Buffering</a> | <a href="#extMaxIdleTime">Max Idle Time</a> | <a href="#backlog">Back Log</a> | <a href="#runOnStartUp">Run On Start Up</a> | <a href="#extAppPriority">Priority</a> | <a href="#memSoftLimit">Memory Soft Limit (bytes)</a> | <a href="#memHardLimit">Memory Hard Limit</a> | <a href="#procSoftLimit">Process Soft Limit</a> | <a href="#procHardLimit">Process Hard Limit</a></p></section>
|
|
</section>
|
|
<section><div class="helpitem"><article class="ls-helpitem"><div><header id="railsDefault"><h3>Ruby Rack/Rails Settings<span class="ls-permlink"><a href="#railsDefault"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Default configurations for Ruby Rack/Rails applications.</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="rubyBin"><h3>Ruby Path<span class="ls-permlink"><a href="#rubyBin"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies path to Ruby executable. Generally, it is /usr/bin/ruby or /usr/local/bin/ruby depending on where Ruby has been installed to.</p> <h4>Syntax</h4><p>Absolute path</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="railsEnv"><h3>Run-Time Mode<span class="ls-permlink"><a href="#railsEnv"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies which mode Rack/Rails will be running as: "Development", "Production", or "Staging". The default is "Production".</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="maxConns"><h3>Max Connections<span class="ls-permlink"><a href="#maxConns"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum number of concurrent connections that can be established between the server and an external application. This setting controls how many requests can be processed concurrently by an external application, however, the real limit also depends on the external application itself. Setting this value higher will not help if the external application is not fast enough or cannot scale to a large number of concurrent requests.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> Setting a high value does not directly translate to higher performance. Setting the limit to a value that will not overload the external application will provide the best performance/throughput.</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="env"><h3>Environment<span class="ls-permlink"><a href="#env"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies extra environment variables for the external application.</p> <h4>Syntax</h4><p>Key=value. Multiple variables can be separated by "ENTER"</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="initTimeout"><h3>Initial Request Timeout (secs)<span class="ls-permlink"><a href="#initTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time in seconds the server will wait for the external application to respond to the first request over a new established connection. If the server does not receive any data from the external application within this timeout limit, it will mark this connection as bad. This helps to identify communication problems with external applications as quickly as possible. If some requests take longer to process, increase this limit to avoid 503 error messages.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="retryTimeout"><h3>Retry Timeout (secs)<span class="ls-permlink"><a href="#retryTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the period of time that the server waits before retrying an external application that had a prior communication problem.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="pcKeepAliveTimeout"><h3>Keep Alive Timeout (secs)<span class="ls-permlink"><a href="#pcKeepAliveTimeout"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum time to keep an idle persistent connection open. When set to "-1", the connection will never timeout. When set to greater than or equal to 0, the connection will be closed after this time in seconds has passed.</p> <h4>Syntax</h4><p>int</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="respBuffer"><h3>Response Buffering<span class="ls-permlink"><a href="#respBuffer"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to buffer responses received from external applications. If a "nph-" (Non-Parsed-Header) script is detected, buffering is turned off for responses with full HTTP headers.</p> <h4>Syntax</h4><p>Select from drop down list</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="extMaxIdleTime"><h3>Max Idle Time<span class="ls-permlink"><a href="#extMaxIdleTime"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the maximum idle time before an external application is stopped by the server. When set to "-1", the external application will not be stopped by the server. The default value is "-1". This feature allows resources used by idle applications to be freed. It is especially useful in the mass hosting environment when you need to define many applications running in "setuid" mode for the sake of maximum security.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> This feature is especially useful in the mass hosting environment. In order to prevent files owned by one virtual host from being accessed by the external application scripts of another virtual host, mass hosting often requires many different applications running at the same time in SetUID mode. Set this Max Idle Time low to prevent these external applications from idling unnecessarily.</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="backlog"><h3>Back Log<span class="ls-permlink"><a href="#backlog"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the backlog of the listening socket. Required if <span class="tagl"><a href="#autoStart">Auto Start</a></span> is enabled.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="runOnStartUp"><h3>Run On Start Up<span class="ls-permlink"><a href="#runOnStartUp"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies whether to start the external application at server start up. Only applicable to external applications that can manage their own child processes and where <span class="tagl"><a href="#instances">Instances</a></span> value is set to "1". If enabled, external processes will be created at server startup instead of run-time.</p> <h4>Syntax</h4><p>Select from radio box</p> <h4>Tips</h4><p><span title="Performance" class="ls-icon-performance"></span> If the configured external process has significant startup overhead, like a Rails app, then this option should be enabled to decrease first page response time.</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="extAppPriority"><h3>Priority<span class="ls-permlink"><a href="#extAppPriority"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies priority of the external application process. Value ranges from <span class="val">-20</span> to <span class="val">20</span>. A lower number means a higher priority. An external application process cannot have a higher priority than the web server. If this priority is set to a lower number than the server's, the server's priority will be used for this value.</p> <h4>Syntax</h4><p>int</p> <h4>See Also</h4><p class="ls-text-small">Server <span class="tagl"><a href="ServGeneral_Help.html#serverPriority">Priority</a></span></p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="memSoftLimit"><h3>Memory Soft Limit (bytes)<span class="ls-permlink"><a href="#memSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies the memory consumption limit in bytes for an external application process or an external application started by the server. <br/><br/> The main purpose of this limit is to prevent excessive memory usage because of software bugs or intentional attacks, not to impose a limit on normal usage. Make sure to leave enough head room, otherwise your application may fail and 503 error may be returned. It can be set at the server- level or at an individual external application level. The server-level limit will be used if it is not set at the individual application level.<br/><br/> The operating system's default setting will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Attention" class="ls-icon-attention"></span> Do not over adjust this limit. This may result in 503 errors if your application needs more memory.</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="memHardLimit"><h3>Memory Hard Limit<span class="ls-permlink"><a href="#memHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#memSoftLimit">Memory Soft Limit (bytes)</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. <br/><br/> The operating system's default will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Example</h4><div class="ls-example">[A] Do not over adjust this limit. This may result in 503 errors if your application need more memory.</div></article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="procSoftLimit"><h3>Process Soft Limit<span class="ls-permlink"><a href="#procSoftLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Limits the total number of processes that can be created on behalf of a user. All existing processes will be counted against this limit, not just new processes to be started.<br/> The limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default setting will be used if this value is 0 or absent at both levels.</p> <h4>Syntax</h4><p>Integer number</p> <h4>Tips</h4><p><span title="Information" class="ls-icon-info"></span> PHP scripts can call for forking processes. The main purpose of this limit is as a last line of defense to prevent fork bombs and other attacks caused by PHP processes creating other processes. <br/> Setting this setting too low can severely hurt functionality. The setting will thus be ignored below certain levels.<br/> When using suEXEC Daemon mode, the actual process limit will be higher than this setting to make sure parent processes are not limited.</p> </article> </div>
|
|
<div class="helpitem"><article class="ls-helpitem"><div><header id="procHardLimit"><h3>Process Hard Limit<span class="ls-permlink"><a href="#procHardLimit"></a></span><span class="top"><a href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Much the same as <span class="tagl"><a href="#procSoftLimit">Process Soft Limit</a></span>, except the soft limit can be raised up to the hard limit from within a user process. The hard limit can be set at the server level or at an individual external application level. The server-level limit will be used if it is not set at an individual application level. The operating system's default value will be used if the value is absent at both levels or set to <span class="val">0</span>.</p> <h4>Syntax</h4><p>Integer number</p> </article> </div>
|
|
</section>
|
|
</article><div class="ls-col-1-1"><footer class="copyright">Copyright © 2013-2017. <a href="https://www.litespeedtech.com">LiteSpeed Technologies Inc.</a> All rights reserved.</footer>
|
|
</div></div>
|
|
</body>
|
|
</html>
|