TODO + MAN pages update
[re6stnet.git] / docs / re6st-registry.rst
1 ================
2  re6st-registry
3 ================
4
5 --------------------------------
6  Server application for re6snet
7 --------------------------------
8
9 :Author: Nexedi
10 :Manual section: 1
11
12 SYNOPSIS
13 ========
14
15 ``re6st-registry`` `port` ``--db`` `db-path` ``--ca`` `ca-path`
16 ``--key`` `key-path` ``--mailhost`` `mailhost` ``--private`` `private-ip`
17 [`options`...]
18
19 DESCRIPTION
20 ===========
21
22 re6st-registry is a server for the re6st network. Its role is to deliver
23 vertificates to new nodes, and to maintain the complete table of peers, so it
24 can send part of it to nodes asking for new peers.
25 As of now, only one re6st-registry per re6st network should run. The node
26 running the re6st-registry must also have a client ( re6stnet ) running.
27
28 USAGE
29 =====
30
31 The re6st-registry will automatically listen on both ipv4 and ipv6 for incomming
32 request.
33
34 port
35             The port on which the server will listen
36
37 --db path
38             Path to the server Database file. A new DB file will be created
39             and correctly initialized if the file doesn't exists.
40             One can give ":memory" as path, the database is then temporary
41
42 --ca path
43             Path to the certificate authority file. The certificate authority
44             MUST contain the VPN network prefix in its serial number. To
45             generate correct ca and key files for the 2001:db8:42:: prefix,
46             the following command can be used :
47             openssl req -nodes -new -x509 -key ca.key -set_serial \
48                     0x120010db80042 -days 365 -out ca.crt
49
50 --key path
51             Path to the server key file. To generate a key file, see the --ca
52             option
53
54 --mailhost mailhost
55             Mailhost to be used to send email containing token for registration
56
57 --private ip
58             Ipv6 address of the re6stnet client running on the machine. This
59             address will be advertised only to nodes having a valid
60             certificate.
61
62 Options
63 -------
64
65 --bootstrap prefix
66             Prefix of a node to be given to other as a bootstrap node to
67             initiate connection with the network.A prefix is an id given to
68             each node, which is used to generate the re6st ip address of the
69             node. A prefix is a string representing binary number.
70             By default the registry delivers 16 bits prefix. You can get your
71             prefix from the python interpreter (see re6stnet man page HOW TO)
72             By default the registry delivers 16 bits prefix.
73             Asusming a network prefix ``2001:db8:42::/48``, the re6st ip address
74             ``2001:db8:42:1::1/64`` corresponds to a prefix ``1/16`` i.e
75             ``00000000000000010``.
76
77 SEE ALSO
78 ========
79
80 ``re6stnet``\ (1), ``re6st-conf``\ (1)