Skip to content

Commit ea02809

Browse files
committed
Update docs
1 parent b6359ac commit ea02809

File tree

6 files changed

+567
-181
lines changed

6 files changed

+567
-181
lines changed

docs/commands/index.html

Lines changed: 124 additions & 64 deletions
Large diffs are not rendered by default.

docs/configuration/index.html

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,10 +290,44 @@
290290

291291

292292

293+
<label class="md-nav__link md-nav__link--active" for="toc">
294+
Configuration
295+
</label>
296+
293297
<a href="./" title="Configuration" class="md-nav__link md-nav__link--active">
294298
Configuration
295299
</a>
296300

301+
302+
<nav class="md-nav md-nav--secondary">
303+
304+
305+
306+
307+
308+
<label class="md-nav__title" for="toc">Table of contents</label>
309+
<ul class="md-nav__list" data-md-scrollfix>
310+
311+
<li class="md-nav__item">
312+
<a href="#top-level-settings" title="Top-level Settings" class="md-nav__link">
313+
Top-level Settings
314+
</a>
315+
316+
</li>
317+
318+
<li class="md-nav__item">
319+
<a href="#queue-settings" title="Queue Settings" class="md-nav__link">
320+
Queue Settings
321+
</a>
322+
323+
</li>
324+
325+
326+
327+
</ul>
328+
329+
</nav>
330+
297331
</li>
298332

299333

@@ -319,6 +353,27 @@
319353

320354

321355

356+
<label class="md-nav__title" for="toc">Table of contents</label>
357+
<ul class="md-nav__list" data-md-scrollfix>
358+
359+
<li class="md-nav__item">
360+
<a href="#top-level-settings" title="Top-level Settings" class="md-nav__link">
361+
Top-level Settings
362+
</a>
363+
364+
</li>
365+
366+
<li class="md-nav__item">
367+
<a href="#queue-settings" title="Queue Settings" class="md-nav__link">
368+
Queue Settings
369+
</a>
370+
371+
</li>
372+
373+
374+
375+
</ul>
376+
322377
</nav>
323378
</div>
324379
</div>
@@ -334,7 +389,11 @@ <h1 id="configuration">Configuration<a class="headerlink" href="#configuration"
334389
<p>Configuration is accomplished by modifying the appsettings.json file that comes with the InEngine.NET binary distribution. The -c, --configuration argument can also be used to specify an alternate configuration file.</p>
335390
<div class="codehilite"><pre><span></span><span class="p">{</span>
336391
<span class="nt">&quot;InEngine&quot;</span><span class="p">:</span> <span class="p">{</span>
392+
<span class="nt">&quot;Plugins&quot;</span><span class="p">:</span> <span class="p">[</span>
393+
<span class="s2">&quot;path/to/MyCommandPlugin&quot;</span>
394+
<span class="p">],</span>
337395
<span class="nt">&quot;Queue&quot;</span><span class="p">:</span> <span class="p">{</span>
396+
<span class="nt">&quot;UseCompression&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
338397
<span class="nt">&quot;PrimaryQueueConsumers&quot;</span><span class="p">:</span> <span class="mi">16</span><span class="p">,</span>
339398
<span class="nt">&quot;SecondaryQueueConsumers&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
340399
<span class="nt">&quot;QueueName&quot;</span><span class="p">:</span> <span class="s2">&quot;InEngine:Queue&quot;</span><span class="p">,</span>
@@ -348,40 +407,71 @@ <h1 id="configuration">Configuration<a class="headerlink" href="#configuration"
348407
</pre></div>
349408

350409

410+
<h2 id="top-level-settings">Top-level Settings<a class="headerlink" href="#top-level-settings" title="Permanent link">&para;</a></h2>
351411
<table>
352412
<thead>
353413
<tr>
354414
<th>Setting</th>
415+
<th>Type</th>
355416
<th>Description</th>
356417
</tr>
357418
</thead>
358419
<tbody>
359420
<tr>
421+
<td>Plugins</td>
422+
<td>array of strings</td>
423+
<td>A list of paths of plugin assemblies, with ".dll" omitted from the assembly name.</td>
424+
</tr>
425+
</tbody>
426+
</table>
427+
<h2 id="queue-settings">Queue Settings<a class="headerlink" href="#queue-settings" title="Permanent link">&para;</a></h2>
428+
<table>
429+
<thead>
430+
<tr>
431+
<th>Setting</th>
432+
<th>Type</th>
433+
<th>Description</th>
434+
</tr>
435+
</thead>
436+
<tbody>
437+
<tr>
438+
<td>UseCompression</td>
439+
<td>bool</td>
440+
<td>A situation performance optimization that compresses queued messages.</td>
441+
</tr>
442+
<tr>
360443
<td>PrimaryQueueConsumers</td>
361-
<td>The number of consumers to schedule for the primary queue.</td>
444+
<td>string</td>
445+
<td>The number of consumers to schedule for the secondary queue.</td>
362446
</tr>
363447
<tr>
364448
<td>SecondaryQueueConsumers</td>
449+
<td>string</td>
365450
<td>The number of consumers to schedule for the secondary queue.</td>
366451
</tr>
367452
<tr>
368453
<td>QueueName</td>
454+
<td>string</td>
369455
<td>The base name of the queue, used to form the Redis Queue keys.</td>
370456
</tr>
371457
<tr>
372458
<td>RedisHost</td>
459+
<td>string</td>
373460
<td>The Redis hostname to connect to.</td>
374461
</tr>
375462
<tr>
376463
<td>RedisPort</td>
464+
<td>integer</td>
377465
<td>Redis's port.</td>
378466
</tr>
379467
<tr>
380468
<td>RedisDb</td>
469+
<td>integer</td>
381470
<td>The Redis database - 0-15</td>
382471
</tr>
383472
<tr>
384473
<td>RedisPassword</td>
474+
<td>string</td>
385475
<td>The Redis auth password</td>
386476
</tr>
387477
</tbody>

0 commit comments

Comments
 (0)