Skip to content

Commit 2334f75

Browse files
committed
Update docs
1 parent 14f256d commit 2334f75

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs-src/server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The server can be run in Global.asax.cs:
2828
using System.Web;
2929
using InEngine.Core;
3030

31-
namespace MyWeApp
31+
namespace MyWebApp
3232
{
3333
public class Global : HttpApplication
3434
{

docs/search/search_index.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@
257257
},
258258
{
259259
"location": "/server/",
260-
"text": "Server\n\n\nWhen run as a service, InEngine runs scheduled commands in the background and actively listens for commands to be queued.\n\n\nRunning the Server\n\n\nThe server can be run in a variety of ways.\n\n\nIn the Foreground\n\n\nRunning the server from the CommandLine is useful for debugging or local development:\n\n\ninengine.exe -s\n\n\n\n\n\nIt can also be run on Mac and Linux with Mono via a shell wrapper script:\n\n\n./inengine -s\n\n\n\n\n\nIn ASP.NET\n\n\nThe server can be run in Global.asax.cs:\n\n\nusing\n \nSystem.Web\n;\n\n\nusing\n \nInEngine.Core\n;\n\n\n\nnamespace\n \nMyWeApp\n\n\n{\n\n \npublic\n \nclass\n \nGlobal\n \n:\n \nHttpApplication\n\n \n{\n\n \npublic\n \nServerHost\n \nServerHost\n \n{\n \nget\n;\n \nset\n;\n \n}\n\n\n \nprotected\n \nvoid\n \nApplication_Start\n()\n\n \n{\n\n \nServerHost\n \n=\n \nnew\n \nServerHost\n();\n\n \nServerHost\n.\nStart\n();\n\n \n}\n\n\n \nprotected\n \nvoid\n \nApplication_End\n()\n\n \n{\n\n \nServerHost\n.\nDispose\n();\n\n \n}\n\n \n}\n\n\n}\n\n\n\n\n\n\nOn Windows as a Service\n\n\nRun the \nInstall.ps1\n PowerShell script in the InEngine directory to install the InEngine as a service. \nThe script needs to be run as an administrator. \nThe script will register the service at the location where the script is run - i.e. put the files where you want them installed before running the installation script.\n\n\nps Install.ps1\n\n\n\n\n\nSimply run the \nUninstall.ps1\n script with elevated permissions to remove the service.\n\n\nps Uninstall.ps1\n\n\n\n\n\nOn Linux with Supervisor\n\n\nSupervisor is a process control system for Linux. \nIt has extensive \ndocumentation\n, but the following should be enough to get started.\n\n\nInstalling Supervisor\n\n\nThis command installs Supervisor on Ubuntu:\n\n\nsudo apt-get install supervisor\n\n\n\n\n\nConfiguring Supervisor\n\n\nSupervisor configuration files are stored in the \n/etc/supervisor/conf.d\n directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called \n/etc/supervisor/conf.d/inengine-scheduler.conf\n. \n\n\n[program:inengine]\n\n\nprocess_name\n=\n%(program_name)s_%(process_num)02d\n\n\ndirectory\n=\n/path/to/inengine\n\n\ncommand\n=\nmono inengine.exe -s\n\n\nautostart\n=\ntrue\n\n\nautorestart\n=\ntrue\n\n\nuser\n=\nInEngine\n\n\nnumprocs\n=\n1\n\n\nredirect_stderr\n=\ntrue\n\n\nstdout_logfile\n=\n./inengine.log\n\n\n\n\n\n\nStarting Supervisor\n\n\nWhenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.\n\n\nsudo supervisorctl reread\nsudo supervisorctl update\n\n\n\n\n\nNow, simply start the server workers with the \nsupervisorctl\n program:\n\n\nsudo supervisorctl start inengine:*\n\n\n\n\n\nIn a Container with Docker\n\n\nInstall \nDocker\n first, then pull the \nethanhann/inengine\n image:\n\n\ndocker pull ethanhann/inengine:latest\n\n\n\n\n\nNow run the InEngine in server mode:\n\n\ndocker run --rm ethanhann/inengine -s",
260+
"text": "Server\n\n\nWhen run as a service, InEngine runs scheduled commands in the background and actively listens for commands to be queued.\n\n\nRunning the Server\n\n\nThe server can be run in a variety of ways.\n\n\nIn the Foreground\n\n\nRunning the server from the CommandLine is useful for debugging or local development:\n\n\ninengine.exe -s\n\n\n\n\n\nIt can also be run on Mac and Linux with Mono via a shell wrapper script:\n\n\n./inengine -s\n\n\n\n\n\nIn ASP.NET\n\n\nThe server can be run in Global.asax.cs:\n\n\nusing\n \nSystem.Web\n;\n\n\nusing\n \nInEngine.Core\n;\n\n\n\nnamespace\n \nMyWebApp\n\n\n{\n\n \npublic\n \nclass\n \nGlobal\n \n:\n \nHttpApplication\n\n \n{\n\n \npublic\n \nServerHost\n \nServerHost\n \n{\n \nget\n;\n \nset\n;\n \n}\n\n\n \nprotected\n \nvoid\n \nApplication_Start\n()\n\n \n{\n\n \nServerHost\n \n=\n \nnew\n \nServerHost\n();\n\n \nServerHost\n.\nStart\n();\n\n \n}\n\n\n \nprotected\n \nvoid\n \nApplication_End\n()\n\n \n{\n\n \nServerHost\n.\nDispose\n();\n\n \n}\n\n \n}\n\n\n}\n\n\n\n\n\n\nOn Windows as a Service\n\n\nRun the \nInstall.ps1\n PowerShell script in the InEngine directory to install the InEngine as a service. \nThe script needs to be run as an administrator. \nThe script will register the service at the location where the script is run - i.e. put the files where you want them installed before running the installation script.\n\n\nps Install.ps1\n\n\n\n\n\nSimply run the \nUninstall.ps1\n script with elevated permissions to remove the service.\n\n\nps Uninstall.ps1\n\n\n\n\n\nOn Linux with Supervisor\n\n\nSupervisor is a process control system for Linux. \nIt has extensive \ndocumentation\n, but the following should be enough to get started.\n\n\nInstalling Supervisor\n\n\nThis command installs Supervisor on Ubuntu:\n\n\nsudo apt-get install supervisor\n\n\n\n\n\nConfiguring Supervisor\n\n\nSupervisor configuration files are stored in the \n/etc/supervisor/conf.d\n directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called \n/etc/supervisor/conf.d/inengine-scheduler.conf\n. \n\n\n[program:inengine]\n\n\nprocess_name\n=\n%(program_name)s_%(process_num)02d\n\n\ndirectory\n=\n/path/to/inengine\n\n\ncommand\n=\nmono inengine.exe -s\n\n\nautostart\n=\ntrue\n\n\nautorestart\n=\ntrue\n\n\nuser\n=\nInEngine\n\n\nnumprocs\n=\n1\n\n\nredirect_stderr\n=\ntrue\n\n\nstdout_logfile\n=\n./inengine.log\n\n\n\n\n\n\nStarting Supervisor\n\n\nWhenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.\n\n\nsudo supervisorctl reread\nsudo supervisorctl update\n\n\n\n\n\nNow, simply start the server workers with the \nsupervisorctl\n program:\n\n\nsudo supervisorctl start inengine:*\n\n\n\n\n\nIn a Container with Docker\n\n\nInstall \nDocker\n first, then pull the \nethanhann/inengine\n image:\n\n\ndocker pull ethanhann/inengine:latest\n\n\n\n\n\nNow run the InEngine in server mode:\n\n\ndocker run --rm ethanhann/inengine -s",
261261
"title": "Server"
262262
},
263263
{
@@ -277,7 +277,7 @@
277277
},
278278
{
279279
"location": "/server/#in-aspnet",
280-
"text": "The server can be run in Global.asax.cs: using System.Web ; using InEngine.Core ; namespace MyWeApp { \n public class Global : HttpApplication \n { \n public ServerHost ServerHost { get ; set ; } \n\n protected void Application_Start () \n { \n ServerHost = new ServerHost (); \n ServerHost . Start (); \n } \n\n protected void Application_End () \n { \n ServerHost . Dispose (); \n } \n } }",
280+
"text": "The server can be run in Global.asax.cs: using System.Web ; using InEngine.Core ; namespace MyWebApp { \n public class Global : HttpApplication \n { \n public ServerHost ServerHost { get ; set ; } \n\n protected void Application_Start () \n { \n ServerHost = new ServerHost (); \n ServerHost . Start (); \n } \n\n protected void Application_End () \n { \n ServerHost . Dispose (); \n } \n } }",
281281
"title": "In ASP.NET"
282282
},
283283
{

docs/server/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@ <h3 id="in-aspnet">In ASP.NET<a class="headerlink" href="#in-aspnet" title="Perm
613613
<div class="codehilite"><pre><span></span><span class="k">using</span> <span class="nn">System.Web</span><span class="p">;</span>
614614
<span class="k">using</span> <span class="nn">InEngine.Core</span><span class="p">;</span>
615615

616-
<span class="k">namespace</span> <span class="nn">MyWeApp</span>
616+
<span class="k">namespace</span> <span class="nn">MyWebApp</span>
617617
<span class="p">{</span>
618618
<span class="k">public</span> <span class="k">class</span> <span class="nc">Global</span> <span class="p">:</span> <span class="n">HttpApplication</span>
619619
<span class="p">{</span>

0 commit comments

Comments
 (0)