Skip to content

Commit ce787c9

Browse files
committed
Update docs
1 parent 2bca308 commit ce787c9

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
@@ -90,5 +90,5 @@ docker pull ethanhann/inengine:latest
9090
Now run the InEngine in server mode:
9191

9292
```bash
93-
docker run --rm inengine -s
93+
docker run --rm ethanhann/inengine -s
9494
```

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\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\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 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\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\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
{
@@ -302,7 +302,7 @@
302302
},
303303
{
304304
"location": "/server/#in-a-container-with-docker",
305-
"text": "Install Docker first, then pull the ethanhann/inengine image: docker pull ethanhann/inengine:latest Now run the InEngine in server mode: docker run --rm inengine -s",
305+
"text": "Install Docker first, then pull the ethanhann/inengine image: docker pull ethanhann/inengine:latest Now run the InEngine in server mode: docker run --rm ethanhann/inengine -s",
306306
"title": "In a Container with Docker"
307307
}
308308
]

docs/server/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -649,7 +649,7 @@ <h3 id="in-a-container-with-docker">In a Container with Docker<a class="headerli
649649

650650

651651
<p>Now run the InEngine in server mode:</p>
652-
<div class="codehilite"><pre><span></span>docker run --rm inengine -s
652+
<div class="codehilite"><pre><span></span>docker run --rm ethanhann/inengine -s
653653
</pre></div>
654654

655655

0 commit comments

Comments
 (0)