config: fix invalid retranstime in RA message
[project/odhcpd.git] / README
diff --git a/README b/README
index c1c0d1e..fbcd993 100644 (file)
--- a/README
+++ b/README
@@ -21,8 +21,8 @@ prefix delegation and can be used to relay RA, DHCPv6 and NDP between routed
    relay:      RD relay between master and slave interfaces
    a) support for rewriting announced DNS-server addresses in relay mode
    
-3. DHCPv6-support with 2 modes of operation
-   server:     minimalistic server mode
+2. DHCPv6-support with 2 modes of operation
+   server: stateless, stateful and PD-server mode
    a) stateless and stateful address assignment
    b) prefix delegation support
    c) dynamic reconfiguration in case prefixes change
@@ -31,7 +31,10 @@ prefix delegation and can be used to relay RA, DHCPv6 and NDP between routed
    relay:      mostly standards-compliant DHCPv6-relay
    a) support for rewriting announced DNS-server addresses
    
-4. Proxy for Neighbor Discovery messages (solicitations and advertisments)
+3. DHCPv4-support
+   server: stateless and stateful mode
+
+4. Proxy for Neighbor Discovery messages (solicitations and advertisements)
    a) support for auto-learning routes to the local routing table
    b) support for marking interfaces "external" not proxying NDP for them
       and only serving NDP for DAD and for traffic to the router itself
@@ -46,40 +49,91 @@ odhcpd uses cmake:
 * To build DEB or RPM packages use: "make package" afterwards.
 
 
-** Server Mode **
-
-0. Server mode is used as a minimalistic alternative for full-blown servers
-   like radvd or ISC DHCP if simplicity or a small footprint matter.
-   Note: The master interface is unused in this mode. It should be set to '.'.
-
-1. If there are non-local addresses assigned to the slave interface when a
-   router solicitation is received, said prefixes are announced automatically
-   for stateless autoconfiguration and also offered via stateful DHCPv6.
-   If all prefixes are bigger than /64 all but the first /64 of these prefixes
-   is offered via DHCPv6-PD to downstream routers.
-
-2. If DNS servers should be announced (DHCPv6 server-mode) then a local DNS-
-   proxy (e.g. dnsmasq) needs to be run on the router itself because 6relayd
-   will always announce a local address as DNS-server (if not otherwise
-   configured).
-
-3. odhcpd is run with the appropriate configuration.
+** Configuration **
+
+odhcpd uses a UCI configuration file in /etc/config/dhcp for configuration
+and may also receive information from ubus
+
+
+Section of type odhcpd
+
+Option         Type    Default                 Description
+legacy         bool    0                       Enable DHCPv4 if start but
+                                               no dhcpv4 option set
+maindhcp       bool    0                       Use odhcpd as the main DHCPv4
+                                               service
+leasefile      string                          DHCP/v6 lease/hostfile
+leasetrigger   string                          Lease trigger script
+loglevel       integer 6                       Syslog level priority (0-7)
+
+
+Sections of type dhcp (configure DHCP / DHCPv6 / RA / NDP service)
+
+Option                 Type    Default                 Description
+interface              string  <name of UCI section>   logical OpenWrt interface
+ifname                 string  <resolved from logical> physical network interface
+networkid              string  same as ifname          compat. alias for ifname
+ignore                 bool    0                       do not serve this interface
+                                                       unless overridden by ra, ndp,
+                                                       dhcpv4 or dhcpv6 options
+master                 bool    0                       is a master interface
+                                                       for relaying
+
+ra                     string  disabled                Router Advert service
+                       [disabled|server|relay|hybrid]
+dhcpv6                 string  disabled                DHCPv6 service
+                       [disabled|server|relay|hybrid]
+dhcpv4                 string  disabled                DHCPv4 service
+                       [disabled|server]
+ndp                    string  disabled                Neighbor Discovery Proxy
+                       [disabled|relay|hybrid]
+
+dynamicdhcp            bool    1                       Dynamically create leases
+                                                       for DHCPv4 and DHCPv6
+router                 list    <local address>         Routers to announce
+                                                       accepts IPv4 only
+dns                    list    <local address>         DNS servers to announce
+                                                       accepts IPv4 and IPv6
+domain                 list    <local search domain>   Search domains to announce
+
+leasetime              string  12h                     DHCPv4 address leasetime
+start                  integer 100                     DHCPv4 pool start
+limit                  integer 150                     DHCPv4 pool size
+
+ra_default             integer 0                       Override default route
+                       0: default, 1: ignore no public address, 2: ignore all
+ra_management          integer 1                       RA management mode
+                       0: no M-Flag but A-Flag, 1: both M and A, 2: M but not A
+ra_offlink             bool    0                       Announce prefixes off-link
+ra_preference          string  medium                  Route(r) preference
+                       [medium|high|low]
+ra_maxinterval         integer 600                     Maximum time allowed between
+                                                       sending unsolicited RA
+ra_mininterval         integer 200                     Minimum time allowed between
+                                                       sending unsolicited RA
+ra_lifetime            integer 1800                    Value to be placed in Router
+                                                       Lifetime field of RA
+ra_useleasetime                bool    0                       Use configured leasetime as
+                                                       limit for the preferred and
+                                                       valid lifetime of a prefix
+ra_reachabletime       integer 0                       Reachable Time in milliseconds to be
+                                                       advertised in RA messages
+ra_retranstime         integer 0                       Retransmit Time in milliseconds to be
+                                                       advertised in RA messages
+ra_hoplimit            integer 0                       Current hoplimit to be advertised
+                                                       in RA messages
+ra_mtu                 integer 0                       MTU to be advertised in
+                                                       RA messages
+ndproxy_routing                bool    1                       Learn routes from NDP
+ndproxy_slave          bool    0                       NDProxy external slave
+
+
+Sections of type host (static leases)
+Option         Type    Default                 Description
+ip             string                          IP-Address to lease
+mac            string                          MAC-address
+duid           string                          DUID in base16
+hostid         string                          IPv6 host identifier
+name           string                          Hostname
+leasetime      string                          DHCPv4/v6 leasetime
 
-
-** Relay Mode **
-
-0. Relay mode is used when a /64-bit IPv6-Prefix should be distributed over
-   several links / isolated layer 2 domains (e.g. if no prefix delegation
-   is available). In this mode NDP (namely Router Discovery and Neighbor
-   Discovery) messages and DHCPv6-messages are proxied. For DHCPv6 also
-   server mode can be used instead of relaying if desired.
-
-1. When starting 6relayd it is required that the master interface - where
-   IPv6-service is already provided - is configured and usable.
-   
-2. If the upstream router doesn't provide or announce a DNS-service that is
-   reachable in an at least site-local scope, a local DNS proxy (e.g. dnsmasq)
-   needs to be run and configued on the same router where 6relayd is running.
-   (This step can most likely be skipped in most environments.)
-   
-3. odhcpd is run with the appropriate configuration.