Added README.radius

README

@@ -33,6 +33,7 @@ autogen            / autogen
 For radius support the freeradius-client library is required. Currently
 (2014-12-10) the best would be to use the version from the git repository
 at: https://github.com/FreeRADIUS/freeradius-client
+See doc/README.radius for more information on its configuration.
 
 === Build instructions ===
 

doc/Makefile.am

@@ -1,6 +1,6 @@
 EXTRA_DIST = design.dia sample.config scripts/ocserv-script sample.passwd \
 	systemd/socket-activated/ocserv.service  systemd/standalone/ocserv.service \
-	systemd/socket-activated/ocserv.socket \
+	systemd/socket-activated/ocserv.socket README.radius \
 	dbus/org.infradead.ocserv.conf profile.xml
 
 dist_man_MANS = ocserv.8 ocpasswd.8 occtl.8

doc/README.radius

@@ -0,0 +1,55 @@
+============================================
+	Using Radius with ocserv
+============================================
+
+Freeradius-client uses a configuration file to setup the
+server configuration. That is typically found at:
+/etc/radiusclient/radiusclient.conf
+
+The important options for ocserv usage are the following:
+dictionary 	/etc/radiusclient/dictionary
+servers         /etc/radiusclient/servers
+
+The dictionary should contain at least the attributes shown below,
+and the servers file should contain the radius server to use.
+
+============================================
+	Dictionary
+============================================
+
+#
+# Ocserv would support the following radious attributes.
+#
+
+#	Standard attributes
+ATTRIBUTE	User-Name		1	string
+ATTRIBUTE	Password		2	string
+ATTRIBUTE	Framed-Protocol		7	integer
+ATTRIBUTE	Framed-IP-Address	8	ipaddr
+ATTRIBUTE	Framed-IP-Netmask	9	ipaddr
+ATTRIBUTE	Acct-Input-Octets	42	integer
+ATTRIBUTE	Acct-Output-Octets	43	integer
+ATTRIBUTE	Acct-Session-Id		44	string
+ATTRIBUTE	Acct-Input-Gigawords	52	integer
+ATTRIBUTE	Acct-Output-Gigawords	53	integer
+
+#	IPv6 attributes
+ATTRIBUTE	Framed-IPv6-Address	168	ipv6addr
+ATTRIBUTE	DNS-Server-IPv6-Address	169	ipv6addr
+
+
+#	Experimental Non Protocol Attributes used by Cistron-Radiusd
+#
+ATTRIBUTE	Group-Name		1030	string
+
+#	DNS server extensions
+VENDOR Microsoft 311
+
+BEGIN-VENDOR Microsoft
+
+ATTRIBUTE	MS-Primary-DNS-Server 	28 	ipaddr
+ATTRIBUTE 	MS-Secondary-DNS-Server 29 	ipaddr
+
+END-VENDOR Microsoft
+
+