INSTALL

   1 1. INSTALLATION
   2
   3   Ignore this file if you have a pre-installed binary package.
   4
   5
   6 1a. SIMPLE INSTALLATION
   7
   8   If you do not need to modify the default configuration, then take
   9 the following steps to build and install the server:
  10
  11
  12         $ ./configure
  13         $ make
  14         $ make install
  15
  16   Note that in this release, the location of the dictionary files has
  17 changed, to /usr/local/share/freeradius/dictionary.  Please ensure
  18 that /etc/raddb/dictionary is THE SAME as ./raddb/dictionary.  If not,
  19 you will have to copy it over by hand;
  20
  21          $ cp ./raddb/dictionary /etc/raddb/dictionary
  22
  23   If you see errors like 'invalid keyword "ATTRIB_NMC"', then you
  24 should update the main dictionary file as described above.
  25
  26   Once the main dictionary file has been updated, and the server has
  27 been verified to work, all of the other (old) dictionary files in
  28 /etc/raddb may be deleted.
  29
  30
  31 1b. CUSTOM INSTALLATION
  32
  33   FreeRADIUS has autoconf support. This means you have to run
  34 ./configure, and then run make.  To see which configuration options
  35 are supported, run './configure --help', and read it's output.  The
  36 following list is a selection from the available flags:
  37
  38   --enable-shared[=PKGS]  build shared libraries [default=yes]
  39   --enable-static[=PKGS]  build static libraries [default=yes]
  40   --enable-fast-install[=PKGS]  optimize for fast installation [default=yes]
  41   --with-logdir=DIR       Directory for logfiles [LOCALSTATEDIR/log]
  42   --with-radacctdir=PATH  Directory for detail files [LOGDIR/radacct]
  43   --with-raddbdir=DIR     Directory for config files [SYSCONFDIR/raddb]
  44   --with-threads          Use threads, if available.  (default=yes)
  45   --with-snmp             Compile in SNMP support. (default=yes)
  46   --disable-ltdl-install  Do not install libltdl
  47   --with-experimental-modules      Use experimental and unstable modules. (default=no)
  48   --enable-developer      Turns on super-duper-extra-compile-warnings
  49                               when using gcc.
  50
  51   To get the defaults that Cistron Radius used up to 1.5.4.3-beta18, use:
  52
  53         ./configure --localstatedir=/var --sysconfdir=/etc
  54
  55   That means binaries will get installed in /usr/local/{bin,sbin},
  56 manpages in /usr/local/man, configuration files in /etc/raddb, and
  57 logfiles in /var/log and /var/log/radacct.
  58
  59   Now type "make". The binaries will be compiled.
  60
  61   Then do "make install". That will install the binaries, the 'man'
  62 pages, and MAY install the configuration files.  If you have not
  63 installed a RADIUS server before, then the configuration files for
  64 FreeRADIUS will be installed.  If you already have a RADIUS server
  65 installed, then FreeRADIUS WILL NOT over-write your current
  66 configuration.  It will warn you about the files it could not install.
  67
  68   If you DO see a warning message about files that could not be
  69 installed, then you should manually 'diff' the files.  There MAY be
  70 changes in the dictionary files which are REQUIRED for a new version
  71 of the software.  These files will NOT be installed over your current
  72 configuration, so you MUST verify and install any problem files by
  73 hand.
  74
  75   It is EXTREMELY helpful to read the output of both 'configure',
  76 'make', and 'make install'.  If a particular module you expected to be
  77 installed was NOT installed, then the output of the
  78 'configure;make;make install' sequence will tell you why that module
  79 was not installed.  Please do NOT post questions to the FreeRADIUS
  80 users list without carefully reading the output of this process.
  81
  82
  83 2. RUNNING THE SERVER
  84
  85   If the server builds and installs, but doesn't run correctly, then
  86 you may use debugging mode to figure out the problem.
  87
  88   This is your BEST HOPE for understanding the problem.  Read ALL of
  89 the messages which are printed to the screen, the answer to your
  90 problem will often be in a warning or error message.
  91
  92   We really can't emphasize that last sentence enough.  Configuring a
  93 RADIUS server for complex local authentication isn't a trivial task.
  94 Your ONLY method for debugging it is to read the debug messages, where
  95 the server will tell you exactly what it's doing, and why.  You should
  96 then compare its behaviour to what you intended, and edit the
  97 configuration files as appropriate.
  98
  99   If you don't use debugging mode, then you will look dumb when you
 100 ask questions on the 'freeradius-users' list, and the answer to your
 101 question was contained in the debug messages you posted to the list.
 102
 103    Since the main developers of FreeRADIUS use debugging mode to track
 104 down their configuration problems with the server, it's a good idea
 105 for you to use it, too.  If you don't, there is little hope for you to
 106 solve ANY configuration problem related to the server.
 107
 108   To start the server in debugging mode, do:
 109
 110         $ radiusd -X
 111
 112   You should see a lot of text printed on the screen as it starts up.
 113 If you don't, or if you see error messages, please read the FAQ:
 114
 115         http://www.freeradius.org/faq/
 116
 117   If the server says "Ready to process requests.", then it is running
 118 properly.  From another shell (or another window), type:
 119
 120         $ radtest test test localhost 0 testing123
 121
 122   You should see the server print out more messages as it receives the
 123 request, and responds to it.  The 'radtest' program should receive the
 124 response within a few seconds.  It doesn't matter if the
 125 authentication request is accepted or rejected, what matters is that
 126 the server received the request, and responded to it.
 127
 128   You can now edit the 'radiusd.conf' file for your local system.
 129 Please read the ENTIRE file carefully, as many configuration options
 130 are only documented in comments in the file.
 131
 132   Configuring and running the server MAY be complicated.  Please read
 133 the documentation in the doc/ directory for further information.  If
 134 you have any issues, the FAQ is also a good place to check.