Skip to content

Commit ca51ae9

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent 34cedcb commit ca51ae9

File tree

3 files changed

+27
-14
lines changed

3 files changed

+27
-14
lines changed

docs/dev/configuration.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1-dev10-53 - Configuration Manual</title>
5+
<title>HAProxy version 3.1-dev10-79 - Configuration Manual</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -4402,7 +4402,7 @@
44024402
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44034403
</p>
44044404
<p class="text-right">
4405-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/22</b></small>
4405+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/24</b></small>
44064406
</p>
44074407
</div>
44084408
<!-- /.sidebar -->
@@ -4413,7 +4413,7 @@
44134413
<div class="text-center">
44144414
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44154415
<h2>Configuration Manual</h2>
4416-
<p><strong>version 3.1-dev10-53</strong></p>
4416+
<p><strong>version 3.1-dev10-79</strong></p>
44174417
<p>
44184418
2024/10/16<br>
44194419

@@ -31269,7 +31269,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3126931269
<br>
3127031270
<hr>
3127131271
<div class="text-right">
31272-
HAProxy 3.1-dev10-53 &ndash; Configuration Manual<br>
31272+
HAProxy 3.1-dev10-79 &ndash; Configuration Manual<br>
3127331273
<small>, 2024/10/16</small>
3127431274
</div>
3127531275
</div>

docs/dev/intro.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1-dev10-53 - Starter Guide</title>
5+
<title>HAProxy version 3.1-dev10-79 - Starter Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -484,7 +484,7 @@
484484
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
485485
</p>
486486
<p class="text-right">
487-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/22</b></small>
487+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/24</b></small>
488488
</p>
489489
</div>
490490
<!-- /.sidebar -->
@@ -495,7 +495,7 @@
495495
<div class="text-center">
496496
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
497497
<h2>Starter Guide</h2>
498-
<p><strong>version 3.1-dev10-53</strong></p>
498+
<p><strong>version 3.1-dev10-79</strong></p>
499499
<p>
500500
<br>
501501

@@ -2515,7 +2515,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
25152515
<br>
25162516
<hr>
25172517
<div class="text-right">
2518-
HAProxy 3.1-dev10-53 &ndash; Starter Guide<br>
2518+
HAProxy 3.1-dev10-79 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/dev/management.html

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1-dev10-53 - Management Guide</title>
5+
<title>HAProxy version 3.1-dev10-79 - Management Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -352,6 +352,8 @@
352352
</div> <!-- /letter -->
353353
<div class="letter" id="letter-E"><h4>E</h4>
354354

355+
<a class="list-group-item" href="#echo">echo</a>
356+
355357
<a class="list-group-item" href="#enable">enable</a>
356358

357359
<a class="list-group-item" href="#enable agent">enable agent</a>
@@ -646,7 +648,7 @@
646648
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
647649
</p>
648650
<p class="text-right">
649-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/22</b></small>
651+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/10/24</b></small>
650652
</p>
651653
</div>
652654
<!-- /.sidebar -->
@@ -657,7 +659,7 @@
657659
<div class="text-center">
658660
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
659661
<h2>Management Guide</h2>
660-
<p><strong>version 3.1-dev10-53</strong></p>
662+
<p><strong>version 3.1-dev10-79</strong></p>
661663
<p>
662664
<br>
663665

@@ -2887,7 +2889,14 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
28872889
</div><pre class="text">$ echo &quot;dump ssl cert cert1.pem&quot; | socat /tmp/sock1 - | openssl storeutl -noout -text /dev/stdin
28882890
</pre><a class="anchor" name="dump"></a><a class="anchor" name="9-dump"></a><a class="anchor" name="9.3-dump"></a><a class="anchor" name="dump (Statistics and monitoring)"></a><a class="anchor" name="dump (Unix Socket commands)"></a><a class="anchor" name="dump stats-file"></a><a class="anchor" name="9-dump stats-file"></a><a class="anchor" name="9.3-dump stats-file"></a><a class="anchor" name="dump stats-file (Statistics and monitoring)"></a><a class="anchor" name="dump stats-file (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="dump stats-file"></a><a href="#9.3-dump%20stats-file">dump stats-file</a></b></div><pre class="text">Generate a stats-file which can be used to preload haproxy counters values on
28892891
startup. See &quot;Stats-file&quot; section for more detail.
2890-
</pre><a class="anchor" name="enable"></a><a class="anchor" name="9-enable"></a><a class="anchor" name="9.3-enable"></a><a class="anchor" name="enable (Statistics and monitoring)"></a><a class="anchor" name="enable (Unix Socket commands)"></a><a class="anchor" name="enable agent"></a><a class="anchor" name="9-enable agent"></a><a class="anchor" name="9.3-enable agent"></a><a class="anchor" name="enable agent (Statistics and monitoring)"></a><a class="anchor" name="enable agent (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="enable agent"></a><a href="#9.3-enable%20agent">enable agent</a></b> <span style="color: #080">&lt;backend&gt;</span>/<span style="color: #080">&lt;server&gt;</span></div><pre class="text">Resume auxiliary agent check that was temporarily stopped.
2892+
</pre><a class="anchor" name="echo"></a><a class="anchor" name="9-echo"></a><a class="anchor" name="9.3-echo"></a><a class="anchor" name="echo (Statistics and monitoring)"></a><a class="anchor" name="echo (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="echo"></a><a href="#9.3-echo">echo</a></b> <span style="color: #080">&lt;text&gt;</span></div><pre class="text">Print some text with the CLI. Can be useful to wrote commentaries between
2893+
commands when dumping the result of multiple commands.
2894+
</pre><div class="separator">
2895+
<span class="label label-success">Example:</span>
2896+
<pre class="prettyprint">
2897+
<code>echo &quot;expert-mode on; echo FDs from fdtab; show fd; echo wild FDs; debug dev fd&quot; | socat /var/run/haproxy.sock -
2898+
</code></pre>
2899+
</div><a class="anchor" name="enable"></a><a class="anchor" name="9-enable"></a><a class="anchor" name="9.3-enable"></a><a class="anchor" name="enable (Statistics and monitoring)"></a><a class="anchor" name="enable (Unix Socket commands)"></a><a class="anchor" name="enable agent"></a><a class="anchor" name="9-enable agent"></a><a class="anchor" name="9.3-enable agent"></a><a class="anchor" name="enable agent (Statistics and monitoring)"></a><a class="anchor" name="enable agent (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="enable agent"></a><a href="#9.3-enable%20agent">enable agent</a></b> <span style="color: #080">&lt;backend&gt;</span>/<span style="color: #080">&lt;server&gt;</span></div><pre class="text">Resume auxiliary agent check that was temporarily stopped.
28912900

28922901
See &quot;<a href="#disable%20agent">disable agent</a>&quot; for details of the effect of temporarily starting
28932902
and stopping an auxiliary agent.
@@ -4887,7 +4896,7 @@ <h3 id="chapter-9.4.1" data-target="9.4.1"><small><a class="small" href="#9.4.1"
48874896

48884897
Note that a reload will close all connections to the master CLI.
48894898
See also the &quot;<a href="#hard-reload">hard-reload</a>&quot; command.
4890-
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.4.1-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Master CLI commands)"></a><a class="anchor" name="show proc"></a><a class="anchor" name="9-show proc"></a><a class="anchor" name="9.4.1-show proc"></a><a class="anchor" name="show proc (Statistics and monitoring)"></a><a class="anchor" name="show proc (Master CLI commands)"></a><div class="keyword"><b><a class="anchor" name="show proc"></a><a href="#9.4.1-show%20proc">show proc</a></b></div><pre class="text">The master CLI introduces a 'show proc' command to surpervise the
4899+
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.4.1-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Master CLI commands)"></a><a class="anchor" name="show proc"></a><a class="anchor" name="9-show proc"></a><a class="anchor" name="9.4.1-show proc"></a><a class="anchor" name="show proc (Statistics and monitoring)"></a><a class="anchor" name="show proc (Master CLI commands)"></a><div class="keyword"><b><a class="anchor" name="show proc"></a><a href="#9.4.1-show%20proc">show proc</a></b> <span style="color: #008">[debug]</span></div><pre class="text">The master CLI introduces a 'show proc' command to surpervise the
48914900
processe.
48924901
</pre><div class="separator">
48934902
<span class="label label-success">Example:</span>
@@ -4906,6 +4915,10 @@ <h3 id="chapter-9.4.1" data-target="9.4.1"><small><a class="small" href="#9.4.1"
49064915
</div><pre class="text">In this example, the master has been reloaded 5 times but one of the old
49074916
worker is still running and survived 3 reloads. You could access the CLI of
49084917
this worker to understand what's going on.
4918+
4919+
The 'debug' parameter is useful to show debug details, it currently shows the
4920+
FDs for IPC communication. Note that the debug output is not guaranteed to be
4921+
stable between haproxy versions.
49094922
</pre><a class="anchor" name="show"></a><a class="anchor" name="9-show"></a><a class="anchor" name="9.4.1-show"></a><a class="anchor" name="show (Statistics and monitoring)"></a><a class="anchor" name="show (Master CLI commands)"></a><a class="anchor" name="show startup-logs"></a><a class="anchor" name="9-show startup-logs"></a><a class="anchor" name="9.4.1-show startup-logs"></a><a class="anchor" name="show startup-logs (Statistics and monitoring)"></a><a class="anchor" name="show startup-logs (Master CLI commands)"></a><div class="keyword"><b><a class="anchor" name="show startup-logs"></a><a href="#9.4.1-show%20startup-logs">show startup-logs</a></b></div><pre class="text">HAProxy needs to be compiled with USE_SHM_OPEN=1 to be used correctly on the
49104923
master CLI or all messages won't be visible.
49114924

@@ -5339,7 +5352,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
53395352
<br>
53405353
<hr>
53415354
<div class="text-right">
5342-
HAProxy 3.1-dev10-53 &ndash; Management Guide<br>
5355+
HAProxy 3.1-dev10-79 &ndash; Management Guide<br>
53435356
<small>, </small>
53445357
</div>
53455358
</div>

0 commit comments

Comments
 (0)