blob: 5dc4b0c956a231ca8c31d70b4d1f87c79baf4c43 [file] [log] [blame]
hilata6ee6e072014-04-20 17:10:18 -05001nfd-status-http-server
2======================
3
Davide Pesavento9f6a7d92020-10-06 15:21:48 -04004Synopsis
5--------
hilata6ee6e072014-04-20 17:10:18 -05006
Davide Pesavento9f6a7d92020-10-06 15:21:48 -04007**nfd-status-http-server** [**-h**] [**-a** *IPADDR*] [**-p** *PORT*] [**-r**] [**-v**]
hilata6ee6e072014-04-20 17:10:18 -05008
9Description
10-----------
11
Davide Pesavento48108e02024-05-13 19:04:25 -040012``nfd-status-http-server`` is a daemon that enables the retrieval of NFD's status over HTTP.
hilata6ee6e072014-04-20 17:10:18 -050013
14Options
15-------
16
17``-h``
Davide Pesavento9f6a7d92020-10-06 15:21:48 -040018 Show help message and exit.
hilata6ee6e072014-04-20 17:10:18 -050019
Junxiao Shif0dfb332017-02-02 05:32:25 +000020``-a <IPADDR>``
hilata6ee6e072014-04-20 17:10:18 -050021 HTTP server IP address (default is 127.0.0.1).
22
Davide Pesavento9f6a7d92020-10-06 15:21:48 -040023``-p <PORT>``
Davide Pesavento48108e02024-05-13 19:04:25 -040024 HTTP server port number (default is 6380).
Davide Pesavento9f6a7d92020-10-06 15:21:48 -040025
hilata6ee6e072014-04-20 17:10:18 -050026``-r``
27 Enable HTTP robots to crawl (disabled by default).
28
29``-v``
30 Verbose mode.
31
32Examples
33--------
34
Davide Pesavento48108e02024-05-13 19:04:25 -040035Start NFD's HTTP status server on all IPv4 interfaces, port 80 (requires root)::
hilata6ee6e072014-04-20 17:10:18 -050036
Davide Pesavento48108e02024-05-13 19:04:25 -040037 nfd-status-http-server -a 0.0.0.0 -p 80
hilata6ee6e072014-04-20 17:10:18 -050038
Davide Pesavento48108e02024-05-13 19:04:25 -040039Start NFD's HTTP status server on all IPv6 interfaces, port 8000::
hilata6ee6e072014-04-20 17:10:18 -050040
Davide Pesavento48108e02024-05-13 19:04:25 -040041 nfd-status-http-server -a :: -p 8000