From: Francis Dupont <fdupont@isc.org>
Date: Fri, 6 Oct 2017 12:10:11 +0000 (+0200)
Subject: [5361] Updated docs
X-Git-Tag: trac5380_base~2^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d5d78cfcf461733978969d2ca89d205713fa16b7;p=thirdparty%2Fkea.git

[5361] Updated docs
---

diff --git a/doc/examples/https/nginx/kea-nginx.conf b/doc/examples/https/nginx/kea-nginx.conf
index e68ffa39cd..cdbd7b35c6 100644
--- a/doc/examples/https/nginx/kea-nginx.conf
+++ b/doc/examples/https/nginx/kea-nginx.conf
@@ -79,8 +79,8 @@ http {
 
         # For the URL https://kea.example.org forward the
         # requests to http://127.0.0.1:8000.
-        # Since kea-shell doesn't currently support URLs with paths we
-        # use location /
+        # kea-shell defaults to / but --path can be used to set another value
+        # for instance kea-shell --path kea which will matches location /kea
         location / {
             proxy_pass http://127.0.0.1:8000;
         }
diff --git a/doc/guide/shell.xml b/doc/guide/shell.xml
index 4490fb6233..1c470cada8 100644
--- a/doc/guide/shell.xml
+++ b/doc/guide/shell.xml
@@ -25,7 +25,7 @@
     <title>Shell Usage</title>
     <para><command>kea-shell</command> is run as follows:
 <screen>
-kea-shell [--host hostname] [--port number] [--timeout seconds] [--service service-name] [command]
+kea-shell [--host hostname] [--port number] [--path path] [--timeout seconds] [--service service-name] [command]
 </screen>
     where:
     </para>
@@ -44,6 +44,15 @@ kea-shell [--host hostname] [--port number] [--timeout seconds] [--service servi
         </simpara>
       </listitem>
 
+      <listitem>
+        <simpara>
+          <command>--path <replaceable>path</replaceable></command> specifies
+          the path in the URL to connect to. If not specified,
+          empty path is used. As CA listens at the empty path
+          this parameter is useful only with a reverse proxy.
+        </simpara>
+      </listitem>
+
       <listitem>
         <simpara>
           <command>--timeout <replaceable>seconds</replaceable></command> specifies the
@@ -119,6 +128,15 @@ $ <userinput>cat param.json | kea-shell --host 192.0.2.1 config-write > result.j
 </screen>
     </para>
 
+    <para>When a reverse proxy is used to de-multiplex requests to different
+    servers the default empty path in the URL is not enough so the
+    <command> --path </command> parameter should be used. For instance
+    if requests to the "/kea" path are forwarded to the CA this can be used:
+<screen>
+$ <userinput>kea-shell --host 192.0.2.1 --port 8001 --path kea ...</userinput>
+</screen>
+    </para>
+
     <para>Kea Shell requires Python to to be installed on the system. It was tested with
     Python 2.7 and various versions
     of Python 3, up to 3.5. Since not every Kea deployment uses this feature and there are