OS Manuals

/usr/bin/nats-server

High-Performance server for NATS.io, the cloud and edge native messaging system.

From nats-server-2.14 2.14.9-r1 (enterprise-packages), captured 2026-11-08 by running nats-server --help (exit 0). permalink

Usage: nats-server [options]

Server Options:
    -a, --addr, --net <host>         Bind to host address (default: 0.0.0.0)
    -p, --port <port>                Use port for clients (default: 4222)
    -n, --name
        --server_name <server_name>  Server name (default: auto)
    -P, --pid <file>                 File to store PID
    -m, --http_port <port>           Use port for http monitoring
    -ms,--https_port <port>          Use port for https monitoring
    -c, --config <file>              Configuration file
    -t                               Test configuration and exit
    -sl,--signal <signal>[=<pid>]    Send signal to nats-server process (ldm, stop, quit, term, reopen, reload)
                                     <pid> can be either a PID (e.g. 1) or the path to a PID file (e.g. /var/run/nats-server.pid)
        --client_advertise <string>  Client URL to advertise to other servers
        --ports_file_dir <dir>       Creates a ports file in the specified directory (<executable_name>_<pid>.ports).

Logging Options:
    -l, --log <file>                 File to redirect log output
    -T, --logtime                    Timestamp log entries (default: true)
        --logtime_utc                Timestamps in UTC instead of local timezone (default: false)
    -s, --syslog                     Log to syslog or windows event log
    -r, --remote_syslog <addr>       Syslog server addr (udp://localhost:514)
    -D, --debug                      Enable debugging output
    -V, --trace                      Trace the raw protocol
    -VV                              Verbose trace (traces system account as well)
    -DV                              Debug and trace
    -DVV                             Debug and verbose trace (traces system account as well)
        --log_size_limit <limit>     Logfile size limit (default: auto)
        --max_traced_msg_len <len>   Maximum printable length for traced messages (default: unlimited)

JetStream Options:
    -js, --jetstream                 Enable JetStream functionality
    -sd, --store_dir <dir>           Set the storage directory

Authorization Options:
        --user <user>                User required for connections
        --pass <password>            Password required for connections
        --auth <token>               Authorization token required for connections

TLS Options:
        --tls                        Enable TLS, do not verify clients (default: false)
        --tlscert <file>             Server certificate file
        --tlskey <file>              Private key for server certificate
        --tlsverify                  Enable TLS, verify client certificates
        --tlscacert <file>           Client certificate CA for verification

Cluster Options:
        --routes <rurl-1, rurl-2>    Routes to solicit and connect
        --cluster <cluster-url>      Cluster URL for solicited routes
        --cluster_name <string>      Cluster Name, if not set one will be dynamically generated
        --no_advertise <bool>        Do not advertise known cluster information to clients
        --cluster_advertise <string> Cluster URL to advertise to other servers
        --connect_retries <number>   For implicit routes, number of connect retries
        --cluster_listen <url>       Cluster url from which members can solicit routes

Profiling Options:
        --profile <port>             Profiling HTTP port

Common Options:
    -h, --help                       Show this message
    -v, --version                    Show version
        --help_tls                   TLS help
Options (44)
OptionDescriptionSource
-a, --addr, --net hostBind to host address (default: 0.0.0.0)help
-p, --port portUse port for clients (default: 4222)help
-n, --namehelp
--server_name server_nameServer name (default: auto)help
-P, --pid fileFile to store PIDhelp
-m, --http_port portUse port for http monitoringhelp
-ms, --https_port portUse port for https monitoringhelp
-c, --config fileConfiguration filehelp
-tTest configuration and exithelp
-sl, --signal signal>[=<pidSend signal to nats-server process (ldm, stop, quit, term, reopen, reload) <pid> can be either a PID (e.g. 1) or the path to a PID file (e.g. /var/run/nats-server.pid)help
--client_advertise stringClient URL to advertise to other servershelp
--ports_file_dir dirCreates a ports file in the specified directory (<executable_name>_<pid>.ports).help
-l, --log fileFile to redirect log outputhelp
-T, --logtimeTimestamp log entries (default: true)help
--logtime_utcTimestamps in UTC instead of local timezone (default: false)help
-s, --syslogLog to syslog or windows event loghelp
-r, --remote_syslog addrSyslog server addr (udp://localhost:514)help
-D, --debugEnable debugging outputhelp
-V, --traceTrace the raw protocolhelp
-VVVerbose trace (traces system account as well)help
-DVDebug and tracehelp
-DVVDebug and verbose trace (traces system account as well)help
--log_size_limit limitLogfile size limit (default: auto)help
--max_traced_msg_len lenMaximum printable length for traced messages (default: unlimited)help
-js, --jetstreamEnable JetStream functionalityhelp
-sd, --store_dir dirSet the storage directoryhelp
--user userUser required for connectionshelp
--pass passwordPassword required for connectionshelp
--auth tokenAuthorization token required for connectionshelp
--tlsEnable TLS, do not verify clients (default: false)help
--tlscert fileServer certificate filehelp
--tlskey filePrivate key for server certificatehelp
--tlsverifyEnable TLS, verify client certificateshelp
--tlscacert fileClient certificate CA for verificationhelp
--routes rurl-1Routes to solicit and connecthelp
--cluster cluster-urlCluster URL for solicited routeshelp
--cluster_name stringCluster Name, if not set one will be dynamically generatedhelp
--no_advertise boolDo not advertise known cluster information to clientshelp
--connect_retries numberFor implicit routes, number of connect retrieshelp
--cluster_listen urlCluster url from which members can solicit routeshelp
--profile portProfiling HTTP porthelp
-h, --helpShow this messagehelp
-v, --versionShow versionhelp
--help_tlsTLS helphelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.