github.com/vmware/transport-go@v1.3.4/plank/utils/cli.go (about)

     1  // Copyright 2019-2021 VMware, Inc.
     2  // SPDX-License-Identifier: BSD-2-Clause
     3  
     4  package utils
     5  
     6  var PlatformServerFlagConstants = map[string]map[string]string{
     7  	"Hostname": {
     8  		"FlagName":    "hostname",
     9  		"ShortFlag":   "n",
    10  		"Description": "Hostname where Plank accepts connections",
    11  	},
    12  	"Port": {
    13  		"FlagName":    "port",
    14  		"ShortFlag":   "p",
    15  		"Description": "Port where Plank is to be served",
    16  	},
    17  	"RootDir": {
    18  		"FlagName":    "rootdir",
    19  		"ShortFlag":   "r",
    20  		"Description": "Root directory for the server (default: Current directory)",
    21  	},
    22  	"Cert": {
    23  		"FlagName":    "cert",
    24  		"Description": "X509 Certificate file for TLS",
    25  	},
    26  	"CertKey": {
    27  		"FlagName":    "cert-key",
    28  		"Description": "X509 Certificate private Key file for TLS",
    29  	},
    30  	"Static": {
    31  		"FlagName":    "static",
    32  		"ShortFlag":   "s",
    33  		"Description": "Path(s) where static files will be served",
    34  	},
    35  	"SpaPath": {
    36  		"FlagName":    "spa-path",
    37  		"Description": "Path to serve Single Page Application (SPA) from. The URI is derived from the leaf directory. A different URI can be specified by providing it following a colon (e.g. --spa-path ./path/to/spa-app:my-spa",
    38  	},
    39  	"NoFabricBroker": {
    40  		"FlagName":    "no-fabric-broker",
    41  		"Description": "Disable Fabric (STOMP) broker",
    42  	},
    43  	"FabricEndpoint": {
    44  		"FlagName":    "fabric-endpoint",
    45  		"Description": "Fabric broker endpoint",
    46  	},
    47  	"TopicPrefix": {
    48  		"FlagName":    "topic-prefix",
    49  		"Description": "Topic prefix for Fabric broker",
    50  	},
    51  	"QueuePrefix": {
    52  		"FlagName":    "query-prefix",
    53  		"Description": "Queue prefix for Fabric broker",
    54  	},
    55  	"RequestPrefix": {
    56  		"FlagName":    "request-prefix",
    57  		"Description": "Application request prefix for Fabric broker",
    58  	},
    59  	"RequestQueuePrefix": {
    60  		"FlagName":    "request-queue-prefix",
    61  		"Description": "Application request queue prefix for Fabric broker",
    62  	},
    63  	"ConfigFile": {
    64  		"FlagName":    "config-file",
    65  		"Description": "Path to the server config JSON file",
    66  	},
    67  	"ShutdownTimeout": {
    68  		"FlagName":    "shutdown-timeout",
    69  		"Description": "Graceful server shutdown timeout in minutes",
    70  	},
    71  	"OutputLog": {
    72  		"FlagName":    "output-log",
    73  		"ShortFlag":   "l",
    74  		"Description": "Platform log output. Possible values: stdout, stderr, null, or path to a file",
    75  	},
    76  	"AccessLog": {
    77  		"FlagName":    "access-log",
    78  		"ShortFlag":   "a",
    79  		"Description": "HTTP server access log output. Possible values: stdout, stderr, null, or path to a file",
    80  	},
    81  	"ErrorLog": {
    82  		"FlagName":    "error-log",
    83  		"ShortFlag":   "e",
    84  		"Description": "HTTP server error log output. Possible values: stdout, stderr, null, or path to a file",
    85  	},
    86  	"Debug": {
    87  		"FlagName":    "debug",
    88  		"ShortFlag":   "d",
    89  		"Description": "Enable debug logging",
    90  	},
    91  	"NoBanner": {
    92  		"FlagName":    "no-banner",
    93  		"ShortFlag":   "b",
    94  		"Description": "Do not print Plank banner at startup",
    95  	},
    96  	"Prometheus": {
    97  		"FlagName":    "prometheus",
    98  		"Description": "Enable Prometheus for basic runtime metrics",
    99  	},
   100  	"RestBridgeTimeout": {
   101  		"FlagName":    "rest-bridge-timeout",
   102  		"Description": "Time in minutes before a REST endpoint for a service request to timeout",
   103  	},
   104  }