Skip to content

Commit 2156377

Browse files
ethanhannethanhann
committed
Update docs
1 parent 17ada8f commit 2156377

File tree

6 files changed

+263
-38
lines changed

6 files changed

+263
-38
lines changed

‎docs-src/configuration.md‎

Lines changed: 43 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,25 @@ The **-c, --configuration** argument can also be used to specify an alternate co
2121
},
2222
"Queue": {
2323
"UseCompression": false,
24-
"PrimaryQueueConsumers": 16,
25-
"SecondaryQueueConsumers": 4,
26-
"QueueDriver": "redis",
24+
"PrimaryQueueConsumers": 4,
25+
"SecondaryQueueConsumers": 2,
26+
"QueueDriver": "rabbitmq",
2727
"QueueName": "InEngineQueue",
28-
"RedisHost": "localhost",
29-
"RedisPort": 6379,
30-
"RedisDb": 0,
31-
"RedisPassword": ""
28+
"Redis": {
29+
"Host": "127.0.0.1",
30+
"Port": 6379,
31+
"Database": 0,
32+
"Password": ""
33+
},
34+
"RabbitMQ": {
35+
"Host": "localhost",
36+
"Port": 5672,
37+
"Username": "",
38+
"Password": ""
39+
},
40+
"File": {
41+
"BasePath": "../"
42+
}
3243
}
3344
}
3445
}
@@ -55,18 +66,39 @@ The **-c, --configuration** argument can also be used to specify an alternate co
5566

5667
## Queue Settings
5768

69+
### General Settings
70+
5871
| Setting | Type | Description |
5972
| ------------------------- | --------- | --------------------------------------------------------------------- |
6073
| UseCompression | bool | A situation performance optimization that compresses queued messages. |
6174
| PrimaryQueueConsumers | string | The number of consumers to schedule for the secondary queue. |
6275
| SecondaryQueueConsumers | string | The number of consumers to schedule for the secondary queue. |
6376
| QueueDriver | string | The driver to use to interact with a queue data store. |
6477
| QueueName | string | The base name of the queue, used to form the Redis Queue keys. |
65-
| RedisHost | string | The Redis hostname to connect to. |
66-
| RedisPort | integer | Redis's port. |
67-
| RedisDb | integer | The Redis database - 0-15 |
68-
| RedisPassword | string | The Redis auth password |
6978

79+
### RabbitMQ Client-specific Settings
80+
81+
| Setting | Type | Description |
82+
| ------------------------- | --------- | --------------------------------------------------------------------- |
83+
| Host | string | The RabbitMQ hostname to connect to. |
84+
| Port | integer | RabbitMQ's port. |
85+
| Username | string | The RabbitMQ username to authenticate with. |
86+
| Password | string | The RabbitMQ password to authenticate with. |
87+
88+
### Redis Client-specific Settings
89+
90+
| Setting | Type | Description |
91+
| ------------------------- | --------- | --------------------------------------------------------------------- |
92+
| Host | string | The Redis hostname to connect to. |
93+
| Port | integer | Redis's port. |
94+
| Database | integer | The Redis database - 0-15. |
95+
| Password | string | The Redis auth password. |
96+
97+
### File Client-specific Settings
98+
99+
| Setting | Type | Description |
100+
| ------------------------- | --------- | --------------------------------------------------------------------- |
101+
| BasePath | string | The file system path where the queue directories should be located. |
70102

71103
## Logging Settings
72104

‎docs-src/queuing.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ It is useful for testing and development, but probably not suitable for producti
2424
### Redis
2525

2626
Redis is suitable for production use.
27-
InEngine.NET utilizes Redis' durable queue features which mean messages will not be lost if InEngine.NET unexpectedly fails.
27+
InEngine.NET utilizes Redis' durable queue features which means messages will not be lost if InEngine.NET unexpectedly fails.
2828

2929
Redis can be installed on Ubuntu with this command:
3030

@@ -42,6 +42,15 @@ sudo service redis start
4242
It is highly recommended to <a href="https://redis.io/topics/security#authentication-feature">set a password</a> for Redis.
4343
</div>
4444

45+
### RabbitMQ
46+
47+
RabbitMQ has built-in acknowledgement and persistence features that make it ideal for production use.
48+
49+
RabbitMQ can be installed on all major platforms, including Windows.
50+
51+
See the [download and installation](https://www.rabbitmq.com/download.html) page to get started.
52+
53+
4554
### Sync
4655

4756
The sync driver causes the publish command to run a published command synchronously.

‎docs/configuration/index.html‎

Lines changed: 154 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,40 @@
408408
Queue Settings
409409
</a>
410410

411+
<nav class="md-nav">
412+
<ul class="md-nav__list">
413+
414+
<li class="md-nav__item">
415+
<a href="#general-settings" title="General Settings" class="md-nav__link">
416+
General Settings
417+
</a>
418+
419+
</li>
420+
421+
<li class="md-nav__item">
422+
<a href="#rabbitmq-client-specific-settings" title="RabbitMQ Client-specific Settings" class="md-nav__link">
423+
RabbitMQ Client-specific Settings
424+
</a>
425+
426+
</li>
427+
428+
<li class="md-nav__item">
429+
<a href="#redis-client-specific-settings" title="Redis Client-specific Settings" class="md-nav__link">
430+
Redis Client-specific Settings
431+
</a>
432+
433+
</li>
434+
435+
<li class="md-nav__item">
436+
<a href="#file-client-specific-settings" title="File Client-specific Settings" class="md-nav__link">
437+
File Client-specific Settings
438+
</a>
439+
440+
</li>
441+
442+
</ul>
443+
</nav>
444+
411445
</li>
412446

413447
<li class="md-nav__item">
@@ -489,6 +523,40 @@
489523
Queue Settings
490524
</a>
491525

526+
<nav class="md-nav">
527+
<ul class="md-nav__list">
528+
529+
<li class="md-nav__item">
530+
<a href="#general-settings" title="General Settings" class="md-nav__link">
531+
General Settings
532+
</a>
533+
534+
</li>
535+
536+
<li class="md-nav__item">
537+
<a href="#rabbitmq-client-specific-settings" title="RabbitMQ Client-specific Settings" class="md-nav__link">
538+
RabbitMQ Client-specific Settings
539+
</a>
540+
541+
</li>
542+
543+
<li class="md-nav__item">
544+
<a href="#redis-client-specific-settings" title="Redis Client-specific Settings" class="md-nav__link">
545+
Redis Client-specific Settings
546+
</a>
547+
548+
</li>
549+
550+
<li class="md-nav__item">
551+
<a href="#file-client-specific-settings" title="File Client-specific Settings" class="md-nav__link">
552+
File Client-specific Settings
553+
</a>
554+
555+
</li>
556+
557+
</ul>
558+
</nav>
559+
492560
</li>
493561

494562
<li class="md-nav__item">
@@ -532,14 +600,25 @@ <h2 id="inengine-settings">InEngine Settings<a class="headerlink" href="#inengin
532600
<span class="p">},</span>
533601
<span class="nt">&quot;Queue&quot;</span><span class="p">:</span> <span class="p">{</span>
534602
<span class="nt">&quot;UseCompression&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
535-
<span class="nt">&quot;PrimaryQueueConsumers&quot;</span><span class="p">:</span> <span class="mi">16</span><span class="p">,</span>
536-
<span class="nt">&quot;SecondaryQueueConsumers&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
537-
<span class="nt">&quot;QueueDriver&quot;</span><span class="p">:</span> <span class="s2">&quot;redis&quot;</span><span class="p">,</span>
603+
<span class="nt">&quot;PrimaryQueueConsumers&quot;</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
604+
<span class="nt">&quot;SecondaryQueueConsumers&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
605+
<span class="nt">&quot;QueueDriver&quot;</span><span class="p">:</span> <span class="s2">&quot;rabbitmq&quot;</span><span class="p">,</span>
538606
<span class="nt">&quot;QueueName&quot;</span><span class="p">:</span> <span class="s2">&quot;InEngineQueue&quot;</span><span class="p">,</span>
539-
<span class="nt">&quot;RedisHost&quot;</span><span class="p">:</span> <span class="s2">&quot;localhost&quot;</span><span class="p">,</span>
540-
<span class="nt">&quot;RedisPort&quot;</span><span class="p">:</span> <span class="mi">6379</span><span class="p">,</span>
541-
<span class="nt">&quot;RedisDb&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
542-
<span class="nt">&quot;RedisPassword&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span>
607+
<span class="nt">&quot;Redis&quot;</span><span class="p">:</span> <span class="p">{</span>
608+
<span class="nt">&quot;Host&quot;</span><span class="p">:</span> <span class="s2">&quot;127.0.0.1&quot;</span><span class="p">,</span>
609+
<span class="nt">&quot;Port&quot;</span><span class="p">:</span> <span class="mi">6379</span><span class="p">,</span>
610+
<span class="nt">&quot;Database&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
611+
<span class="nt">&quot;Password&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span>
612+
<span class="p">},</span>
613+
<span class="nt">&quot;RabbitMQ&quot;</span><span class="p">:</span> <span class="p">{</span>
614+
<span class="nt">&quot;Host&quot;</span><span class="p">:</span> <span class="s2">&quot;localhost&quot;</span><span class="p">,</span>
615+
<span class="nt">&quot;Port&quot;</span><span class="p">:</span> <span class="mi">5672</span><span class="p">,</span>
616+
<span class="nt">&quot;Username&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
617+
<span class="nt">&quot;Password&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span>
618+
<span class="p">},</span>
619+
<span class="nt">&quot;File&quot;</span><span class="p">:</span> <span class="p">{</span>
620+
<span class="nt">&quot;BasePath&quot;</span><span class="p">:</span> <span class="s2">&quot;../&quot;</span>
621+
<span class="p">}</span>
543622
<span class="p">}</span>
544623
<span class="p">}</span>
545624
<span class="p">}</span>
@@ -596,6 +675,7 @@ <h2 id="mail-settings">Mail Settings<a class="headerlink" href="#mail-settings"
596675
</tbody>
597676
</table>
598677
<h2 id="queue-settings">Queue Settings<a class="headerlink" href="#queue-settings" title="Permanent link">&para;</a></h2>
678+
<h3 id="general-settings">General Settings<a class="headerlink" href="#general-settings" title="Permanent link">&para;</a></h3>
599679
<table>
600680
<thead>
601681
<tr>
@@ -630,25 +710,86 @@ <h2 id="queue-settings">Queue Settings<a class="headerlink" href="#queue-setting
630710
<td>string</td>
631711
<td>The base name of the queue, used to form the Redis Queue keys.</td>
632712
</tr>
713+
</tbody>
714+
</table>
715+
<h3 id="rabbitmq-client-specific-settings">RabbitMQ Client-specific Settings<a class="headerlink" href="#rabbitmq-client-specific-settings" title="Permanent link">&para;</a></h3>
716+
<table>
717+
<thead>
718+
<tr>
719+
<th>Setting</th>
720+
<th>Type</th>
721+
<th>Description</th>
722+
</tr>
723+
</thead>
724+
<tbody>
725+
<tr>
726+
<td>Host</td>
727+
<td>string</td>
728+
<td>The RabbitMQ hostname to connect to.</td>
729+
</tr>
730+
<tr>
731+
<td>Port</td>
732+
<td>integer</td>
733+
<td>RabbitMQ's port.</td>
734+
</tr>
735+
<tr>
736+
<td>Username</td>
737+
<td>string</td>
738+
<td>The RabbitMQ username to authenticate with.</td>
739+
</tr>
740+
<tr>
741+
<td>Password</td>
742+
<td>string</td>
743+
<td>The RabbitMQ password to authenticate with.</td>
744+
</tr>
745+
</tbody>
746+
</table>
747+
<h3 id="redis-client-specific-settings">Redis Client-specific Settings<a class="headerlink" href="#redis-client-specific-settings" title="Permanent link">&para;</a></h3>
748+
<table>
749+
<thead>
750+
<tr>
751+
<th>Setting</th>
752+
<th>Type</th>
753+
<th>Description</th>
754+
</tr>
755+
</thead>
756+
<tbody>
633757
<tr>
634-
<td>RedisHost</td>
758+
<td>Host</td>
635759
<td>string</td>
636760
<td>The Redis hostname to connect to.</td>
637761
</tr>
638762
<tr>
639-
<td>RedisPort</td>
763+
<td>Port</td>
640764
<td>integer</td>
641765
<td>Redis's port.</td>
642766
</tr>
643767
<tr>
644-
<td>RedisDb</td>
768+
<td>Database</td>
645769
<td>integer</td>
646-
<td>The Redis database - 0-15</td>
770+
<td>The Redis database - 0-15.</td>
771+
</tr>
772+
<tr>
773+
<td>Password</td>
774+
<td>string</td>
775+
<td>The Redis auth password.</td>
647776
</tr>
777+
</tbody>
778+
</table>
779+
<h3 id="file-client-specific-settings">File Client-specific Settings<a class="headerlink" href="#file-client-specific-settings" title="Permanent link">&para;</a></h3>
780+
<table>
781+
<thead>
782+
<tr>
783+
<th>Setting</th>
784+
<th>Type</th>
785+
<th>Description</th>
786+
</tr>
787+
</thead>
788+
<tbody>
648789
<tr>
649-
<td>RedisPassword</td>
790+
<td>BasePath</td>
650791
<td>string</td>
651-
<td>The Redis auth password</td>
792+
<td>The file system path where the queue directories should be located.</td>
652793
</tr>
653794
</tbody>
654795
</table>

‎docs/queuing/index.html‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,13 @@
390390
Redis
391391
</a>
392392

393+
</li>
394+
395+
<li class="md-nav__item">
396+
<a href="#rabbitmq" title="RabbitMQ" class="md-nav__link">
397+
RabbitMQ
398+
</a>
399+
393400
</li>
394401

395402
<li class="md-nav__item">
@@ -619,6 +626,13 @@
619626
Redis
620627
</a>
621628

629+
</li>
630+
631+
<li class="md-nav__item">
632+
<a href="#rabbitmq" title="RabbitMQ" class="md-nav__link">
633+
RabbitMQ
634+
</a>
635+
622636
</li>
623637

624638
<li class="md-nav__item">
@@ -802,7 +816,7 @@ <h3 id="file">File<a class="headerlink" href="#file" title="Permanent link">&par
802816
It is useful for testing and development, but probably not suitable for production.</p>
803817
<h3 id="redis">Redis<a class="headerlink" href="#redis" title="Permanent link">&para;</a></h3>
804818
<p>Redis is suitable for production use.
805-
InEngine.NET utilizes Redis' durable queue features which mean messages will not be lost if InEngine.NET unexpectedly fails. </p>
819+
InEngine.NET utilizes Redis' durable queue features which means messages will not be lost if InEngine.NET unexpectedly fails. </p>
806820
<p>Redis can be installed on Ubuntu with this command:</p>
807821
<div class="codehilite"><pre><span></span>sudo apt-get install redis-server
808822
</pre></div>
@@ -817,6 +831,10 @@ <h3 id="redis">Redis<a class="headerlink" href="#redis" title="Permanent link">&
817831
It is highly recommended to <a href="https://redis.io/topics/security#authentication-feature">set a password</a> for Redis.
818832
</div>
819833

834+
<h3 id="rabbitmq">RabbitMQ<a class="headerlink" href="#rabbitmq" title="Permanent link">&para;</a></h3>
835+
<p>RabbitMQ has built-in acknowledgement and persistence features that make it ideal for production use. </p>
836+
<p>RabbitMQ can be installed on all major platforms, including Windows.</p>
837+
<p>See the <a href="https://www.rabbitmq.com/download.html">download and installation</a> page to get started.</p>
820838
<h3 id="sync">Sync<a class="headerlink" href="#sync" title="Permanent link">&para;</a></h3>
821839
<p>The sync driver causes the publish command to run a published command synchronously.
822840
All other queue commands and methods are not supported and will throw an exception if called.

0 commit comments

Comments
 (0)