| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 1 | nfd-status-http-server |
| 2 | ====================== |
| 3 | |
| Davide Pesavento | 9f6a7d9 | 2020-10-06 15:21:48 -0400 | [diff] [blame] | 4 | Synopsis |
| 5 | -------- |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 6 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 7 | | **nfd-status-http-server** [**-a**\|\ **\--address** *address*] [**-p**\|\ **\--port** *port*] \ |
| 8 | [**-f**\|\ **\--workdir** *dir*] [**-r**\|\ **\--robots**] [**-v**\|\ **\--verbose**] |
| 9 | | **nfd-status-http-server** **-h**\|\ **\--help** |
| 10 | | **nfd-status-http-server** **-V**\|\ **\--version** |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 11 | |
| 12 | Description |
| 13 | ----------- |
| 14 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 15 | :program:`nfd-status-http-server` is a daemon that enables the retrieval of NFD's status over HTTP. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 16 | |
| 17 | Options |
| 18 | ------- |
| 19 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 20 | .. option:: -a <address>, --address <address> |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 21 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 22 | HTTP server IP address (default is 127.0.0.1). |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 23 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 24 | .. option:: -p <port>, --port <port> |
| Davide Pesavento | 9f6a7d9 | 2020-10-06 15:21:48 -0400 | [diff] [blame] | 25 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 26 | HTTP server port number (default is 6380). |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 27 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 28 | .. option:: -f <dir>, --workdir <dir> |
| 29 | |
| 30 | Set the server's working directory. |
| 31 | |
| 32 | .. option:: -r, --robots |
| 33 | |
| 34 | Enable HTTP robots to crawl (disabled by default). |
| 35 | |
| 36 | .. option:: -v, --verbose |
| 37 | |
| 38 | Enable verbose mode. |
| 39 | |
| 40 | .. option:: -h, --help |
| 41 | |
| 42 | Print help message and exit. |
| 43 | |
| 44 | .. option:: -V, --version |
| 45 | |
| 46 | Show version information and exit. |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 47 | |
| 48 | Examples |
| 49 | -------- |
| 50 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 51 | ``nfd-status-http-server -a 0.0.0.0 -p 80`` |
| 52 | Start NFD's HTTP status server on all IPv4 interfaces, port 80 (requires privileges). |
| hilata | 6ee6e07 | 2014-04-20 17:10:18 -0500 | [diff] [blame] | 53 | |
| Davide Pesavento | 543b152 | 2024-06-25 17:00:32 -0400 | [diff] [blame] | 54 | ``nfd-status-http-server -a :: -p 8000`` |
| 55 | Start NFD's HTTP status server on all IPv6 interfaces, port 8000. |