Update docs to include new TLS server and client params.

jrasell · May 10, 2019 · 2adb495 · 2adb495
1 parent c3e6041
commit 2adb495
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/commands/README.md b/docs/commands/README.md
@@ -20,6 +20,15 @@ There are a number of command and subcommand options available. Construct your V
 sherpa <command> <subcommand> [options] [args]
 ```
 
+## General Options
+
+The following options are available to all Sherpa CLI commands and help set client connection variables.
+
+* `--addr` (string: "http://127.0.0.1:8000") - The HTTP(S) address of the sherpa server
+* `--client-ca-path` (string: "") - Path to a PEM encoded CA cert file to use to verify the Sherpa server SSL certificate.
+* `--client-cert-key-path` (string: "") - Path to an unencrypted PEM encoded private key matching the client certificate
+* `--client-cert-path string` (string: "") - Path to a PEM encoded client certificate for TLS authentication to the Sherpa server
+
 ## Exit Codes
 
 The Sherpa CLI aims to be consistent and well-behaved using [sysexits](https://github.com/sean-/sysexits) for CLI exit codes.

diff --git a/docs/configuration/README.md b/docs/configuration/README.md
@@ -16,6 +16,8 @@ The Sherpa server can be configured by supplying either CLI flags or using envir
 * `--log-format` (string: "auto") - Is the format at which to log to and can be "auto", "zerolog" or "human".
 * `--log-level` (string: "info") - The level at which Sherpa should log to. Valid log levels include WARN, INFO, or DEBUG in increasing order of verbosity.
 * `--log-use-color` (bool: true) - Specifies whether to use ANSI colour logging.
+* `--tls-cert-key-path` (string: "") - Path to the TLS certificate key for the Sherpa server.
+* `--tls-cert-path` (string: "") - Path to the TLS certificate for the Sherpa server.
 
 ### Environment Variables