summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorBen Morrison <ben@gbmor.dev>2019-06-12 22:04:12 -0400
committerBen Morrison <ben@gbmor.dev>2019-06-12 22:04:12 -0400
commitdca21841d61486105bc74d7bfcbe3c78e75c238e (patch)
tree05d10cb1a38a81af560aaafe9129b51b1f3e3560
parentee0d42110b05ee7173c484a09889b876242f849e (diff)
downloadgetwtxt-dca21841d61486105bc74d7bfcbe3c78e75c238e.tar.gz
added new options to manual
-rw-r--r--svc/help.go34
1 files changed, 30 insertions, 4 deletions
diff --git a/svc/help.go b/svc/help.go
index 09faadb..f3bbfab 100644
--- a/svc/help.go
+++ b/svc/help.go
@@ -93,9 +93,28 @@ func manualScreen() {
  customize your instance of getwtxt. None are required, they will 
  simply use their default value unless otherwise specified.
 
+    BehindProxy: Informs getwtxt whether it is behind a
+        reverse proxy, such as nginx or Caddy. If set to
+        false, getwtxt will use host matching for
+        incoming requests. The host matched is the URL
+        suboption of Instance in the config file.
+        Default: true
+
     ListenPort: Defines the port getwtxt should bind to.
         Default: 9001
 
+    UseTLS: Boolean value that lets getwtxt know if it
+        should use TLS for incoming connections.
+        Default: false
+
+    TLSCert: Absolute path to the certificate file used
+        for TLS connections.
+        Default: /etc/ssl/getwtxt.pem
+
+    TLSKey: Absolute path to the private TLS key file
+        used for TLS connections.
+        Default: /etc/ssl/private/getwtxt.pem
+
     DatabaseType: The type of back-end getwtxt should use
         to store registry data. The available types of
         databases are: leveldb
@@ -120,9 +139,14 @@ func manualScreen() {
         is running.
         Default: false
 
-    LogFile: The location of getwtxt's log file. This,
-        like DatabasePath, can be relative or absolute.
-        Default: getwtxt.log
+    MessageLog: The location of getwtxt's error and 
+        other messages log file. This, like DatabasePath, 
+        can be relative or absolute.
+        Default: logs/message.log
+
+    RequestLog: The location of getwtxt's request log
+        file. The path can be relative or absolute.
+        Default: logs/request.log
 
     DatabasePushInterval: The interval on which getwtxt
         will push registry data from the in-memory cache
@@ -209,7 +233,9 @@ func manualScreen() {
 
     {{.URL}} The publicly-accessible URL of your instance. In
         the default landing page, example API calls are shown
-        using this URL for the convenience of the user.
+        using this URL for the convenience of the user. This
+        is also used as the matched host when the "BehindProxy"
+        value in the configuration file is set to false.
 
 
               :: Interacting with the Registry ::