blob: 14525e3cdd935ebc6f08a0fc839c1239ef60af85 [file] [log] [blame]
hilata6ee6e072014-04-20 17:10:18 -05001.. _ndn-autoconfig-server:
2
Alexander Afanasyev49272f72014-04-06 21:49:46 -07003ndn-autoconfig-server
4=====================
5
hilata6ee6e072014-04-20 17:10:18 -05006Usage
7-----
Alexander Afanasyev49272f72014-04-06 21:49:46 -07008
9::
10
Junxiao Shif0dfb332017-02-02 05:32:25 +000011 ndn-autoconfig-server [-h] [-p <PREFIX>] [-p <PREFIX>] ... <FACEURI>
Alexander Afanasyev49272f72014-04-06 21:49:46 -070012
13
14Description
15-----------
16
Niv Sardi5e8755c2016-12-13 14:11:53 -030017``ndn-autoconfig-server`` is a daemon that implements the server part for the stage 1 of
hilata6ee6e072014-04-20 17:10:18 -050018:ref:`NDN hub discovery procedure`.
19
20This daemon essentially waits for Interests for ``/localhop/ndn-autoconf/hub`` and
Niv Sardi5e8755c2016-12-13 14:11:53 -030021satisfies them with a Data packet that contains a TLV-encoded FaceUri block. The value of
22this block is the ``Uri`` for the HUB, preferably a UDP tunnel.
hilata6ee6e072014-04-20 17:10:18 -050023
24``-h``
25 print usage and exit.
26
Junxiao Shif0dfb332017-02-02 05:32:25 +000027``<FACEURI>``
hilata6ee6e072014-04-20 17:10:18 -050028 FaceUri for this NDN hub.
29
Junxiao Shif0dfb332017-02-02 05:32:25 +000030``-p <PREFIX>``
Niv Sardi5e8755c2016-12-13 14:11:53 -030031 A local prefix for which the local hub allows end applications to register prefixes
Yingdi Yu7b0e9cf2014-08-29 14:57:32 -070032 (See more details in :ref:`local-prefix-discovery`). One can supply more than one
33 prefixes. All supplied prefixes will be put into the local prefix discovery data
34 as described in :ref:`local-prefix-discovery`. If no prefix is specified,
35 auto-config-server will not serve any local prefix discovery data.
36
hilata6ee6e072014-04-20 17:10:18 -050037Examples
38--------
39
Alexander Afanasyev49272f72014-04-06 21:49:46 -070040::
41
hilata6ee6e072014-04-20 17:10:18 -050042 ndn-autoconfig-server tcp://spurs.cs.ucla.edu
Alexander Afanasyev49272f72014-04-06 21:49:46 -070043
Yingdi Yu7b0e9cf2014-08-29 14:57:32 -070044 ndn-autoconfig-server -p /ndn/edu/ucla tcp://spurs.cs.ucla.edu
45
hilata6ee6e072014-04-20 17:10:18 -050046
47See also
48--------
49
50:ref:`ndn-autoconfig`