1NATS-SERVER(1)                   User Commands                  NATS-SERVER(1)
2
3
4

NAME

6       nats-server - manual page for nats-server 2.10.5
7

SYNOPSIS

9       nats-server [options]
10

DESCRIPTION

12   Server Options:
13       -a, --addr, --net <host>
14              Bind to host address (default: 0.0.0.0)
15
16       -p, --port <port>
17              Use port for clients (default: 4222)
18
19       -n, --name
20
21       --server_name <server_name>
22              Server name (default: auto)
23
24       -P, --pid <file>
25              File to store PID
26
27       -m, --http_port <port>
28              Use port for http monitoring
29
30       -ms,--https_port <port>
31              Use port for https monitoring
32
33       -c, --config <file>
34              Configuration file
35
36       -t     Test configuration and exit
37
38       -sl,--signal <signal>[=<pid>]
39              Send  signal  to nats-server process (ldm, stop, quit, term, re‐
40              open, reload) pid> can be either a PID (e.g. 1) or the path to a
41              PID file (e.g. /var/run/nats-server.pid)
42
43       --client_advertise <string>
44              Client URL to advertise to other servers
45
46       --ports_file_dir <dir>
47              Creates   a   ports  file  in  the  specified  directory  (<exe‐
48              cutable_name>_<pid>.ports).
49
50   Logging Options:
51       -l, --log <file>
52              File to redirect log output
53
54       -T, --logtime
55              Timestamp log entries (default: true)
56
57       -s, --syslog
58              Log to syslog or windows event log
59
60       -r, --remote_syslog <addr>
61              Syslog server addr (udp://localhost:514)
62
63       -D, --debug
64              Enable debugging output
65
66       -V, --trace
67              Trace the raw protocol
68
69       -VV    Verbose trace (traces system account as well)
70
71       -DV    Debug and trace
72
73       -DVV   Debug and verbose trace (traces system account as well)
74
75       --log_size_limit <limit>
76              Logfile size limit (default: auto)
77
78       --max_traced_msg_len <len>
79              Maximum printable length for traced  messages  (default:  unlim‐
80              ited)
81
82   JetStream Options:
83       -js, --jetstream
84              Enable JetStream functionality
85
86       -sd, --store_dir <dir>
87              Set the storage directory
88
89   Authorization Options:
90       --user <user>
91              User required for connections
92
93       --pass <password>
94              Password required for connections
95
96       --auth <token>
97              Authorization token required for connections
98
99   TLS Options:
100       --tls  Enable TLS, do not verify clients (default: false)
101
102       --tlscert <file>
103              Server certificate file
104
105       --tlskey <file>
106              Private key for server certificate
107
108       --tlsverify
109              Enable TLS, verify client certificates
110
111       --tlscacert <file>
112              Client certificate CA for verification
113
114   Cluster Options:
115       --routes <rurl-1, rurl-2>
116              Routes to solicit and connect
117
118       --cluster <cluster-url>
119              Cluster URL for solicited routes
120
121       --cluster_name <string>
122              Cluster Name, if not set one will be dynamically generated
123
124       --no_advertise <bool>
125              Do not advertise known cluster information to clients
126
127       --cluster_advertise <string> Cluster URL to advertise to other servers
128
129       --connect_retries <number>
130              For implicit routes, number of connect retries
131
132       --cluster_listen <url>
133              Cluster url from which members can solicit routes
134
135   Profiling Options:
136       --profile <port>
137              Profiling HTTP port
138
139   Common Options:
140       -h, --help
141              Show this message
142
143       -v, --version
144              Show version
145
146       --help_tls
147              TLS help
148
149
150
151nats-server 2.10.5               November 2023                  NATS-SERVER(1)