AXL Radius Server API:

To view the documentation use the path docs/index.html in a web browser.

Directories:

docs:
	Contains the HTML API documentation, RADIUS programming guide, and CHANGES
	list. Use doc/index.html as the starting point.
	The programming guide and other information is found under the 'Overview'
	navigation link in the API documentation. See
	http://www.axlradius.com for the latest version of the
	documentation.

lib:
	The radserver3.jar file is kept in /lib. It should be moved to your classpath to run
	your server implementation.

dictionary:
	This contains a zip file of radius dictionaries. You will want to extract these to
	 create your own local dictionary supporting your own vendors and the basic
	 RADIUS attributes.

	 The utility com.theorem.radserver3.dictionary.util.GenererateJavaDictionary
	 will generate the necessary LocalDictionary.java. The file GenerateJavaDictionary.properties
	 should be edited to suit your system. Also edit the file 'dictionary' in the 'dictionary' zip file
	 to include the dictionaries you need. More instructions are found in the properties file.

com:
	This directory contains all the source files your distribution allows you to have.
	These may be compiled or examined. Recompilation is not necessary since the
	radserver3.jar file in the 'lib' directory contains all necessary classes.

examples:
	The examples directory is found in com/theorem/radserver3/examples. There 
	are various client examples and an example server. The scripts in each 
	example assume you are in the specific example's directory.

	An example: You want to run the sample server. Change your directory to 
	com/theorem/radserver3/examples/server. Then run the shell script or batch 
	file axlserver. These scripts have a path to the server's jar file and will 
	run from the 'server' directory.

A short description of each of the examples:
	radauth A radius authentication client that sends simple requests using a variety of authentication
			methods including PAP, CHAP, MSCHAP, MSCHAP2, and EAP-MD5.
			The client is command line driven and is the easiest to use.

	client	A client that can perform authentication and accounting.  It uses nonsense attributes
			and may be modified to send reasonable attributes.
			The configuration file is radtest.properties which holds information on the server, debugging,
			and other controls.

	clientload Client to simulate loads on a server.  The configuration file is clientload.properties.
			The properties file holds information on the server, the number of threads, iterations per
			thread, and mix of authentication and accounting attempts.  It displays the results when
			all threads have been completed.  Initially it's a good idea to set the threads iterations to one
			so that the server configuration can be checked.

	login: A test of the RADIUSLogin JAAS (javax.security.auth.login).

	server A RADIUS server that handles authentication, accounting and proxy actions.  There are
			two configuration files: login.txt which controls clients and server.properties which controls
			the server's general information such as log files, SNMP, debugging, NAS's, proxy servers, etc.

If there are problems installing, compiling, or in the operation of the server please contact
AXL Software at http://www.axlradius.com

Installation:
	Move the lib/raderver3.jar file to wherever you like and include
	it in your classpath.