INSTALL

   1 1. INSTALLATION
   2
   3   Ignore this file if you have a pre-installed binary package.
   4
   5
   6 2. 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   The first time after installation, you should run the server as
  17 "root".  This will cause the server to create the certificates it
  18 needs for EAP.
  19
  20         $ radiusd -X
  21
  22   Once that is done, the server can be run from an unpriviledged user
  23 account.
  24
  25
  26 3. UPGRADING
  27
  28   The installation process will not over-write your existing
  29 configuration files.  It will, however, warn you about the files it
  30 did not install.
  31
  32   For users upgrading from 1.x to 2.0, we STRONGLY recommend that 2.0
  33 be installed in a different location than the existing 1.x
  34 installation.  Any local policies can then be migrated gradually to
  35 the new 2.0 configuration.  While we have put a lot of time into
  36 ensuring that 2.0 is mostly backwards compatible with 1.x, it is not
  37 COMPLETELY backwards compatible.  There are differences that mean it
  38 is simpler and safer to migrate your configurations.
  39
  40   If you are upgrading an existing installation, please be aware that
  41 at least one default virtual server SHOULD be used.  If you don't need
  42 virtual servers, your configuration can remain mostly unchanged.
  43
  44   If you do need virtual servers, we recommend creating a default one
  45 by editing radiusd.conf, and wrapping all of the authorize,
  46 authenticate, etc. sections in one server block, as follows:
  47
  48 ...
  49   server {      # line to add
  50         authorize {
  51                 ...
  52         }
  53         authenticate {
  54                 ...
  55         }
  56         accounting {
  57                 ...
  58         }
  59         ...
  60         post-proxy {
  61                 ...
  62         }
  63   }             # matching line to add
  64 ...
  65
  66
  67 4. CUSTOM INSTALLATION
  68
  69   FreeRADIUS has autoconf support. This means you have to run
  70 ./configure, and then run make.  To see which configuration options
  71 are supported, run './configure --help', and read it's output.  The
  72 following list is a selection from the available flags:
  73
  74   --enable-shared[=PKGS]  build shared libraries [default=yes]
  75   --enable-static[=PKGS]  build static libraries [default=yes]
  76   --enable-fast-install[=PKGS]  optimize for fast installation [default=yes]
  77   --with-logdir=DIR       Directory for logfiles [LOCALSTATEDIR/log]
  78   --with-radacctdir=PATH  Directory for detail files [LOGDIR/radacct]
  79   --with-raddbdir=DIR     Directory for config files [SYSCONFDIR/raddb]
  80   --with-threads          Use threads, if available.  (default=yes)
  81   --with-snmp             Compile in SNMP support. (default=yes)
  82   --disable-ltdl-install  Do not install libltdl
  83   --with-experimental-modules      Use experimental and unstable modules. (default=no)
  84   --enable-developer      Turns on super-duper-extra-compile-warnings
  85                               when using gcc.
  86   --with-edir             Compile with support for Novell eDirectory
  87                               integration.
  88
  89   The "make install" stage will install the binaries, the 'man' pages,
  90 and MAY install the configuration files.  If you have not installed a
  91 RADIUS server before, then the configuration files for FreeRADIUS will
  92 be installed.  If you already have a RADIUS server installed, then
  93
  94         ** FreeRADIUS WILL NOT over-write your current configuration. **
  95
  96   The "make install" process will warn you about the files it could
  97 not install.
  98
  99   If you DO see a warning message about files that could not be
 100 installed, the it is YOUR RESPONSIBILITY to ensure that the new server
 101 is using the new configuration files, and not the old configuration
 102 files.  You may need to manually 'diff' the files.  There MAY be
 103 changes in the dictionary files which are REQUIRED for a new version
 104 of the software.  These files will NOT be installed over your current
 105 configuration, so you MUST verify and install any problem files by
 106 hand.
 107
 108   It is EXTREMELY helpful to read the output of both 'configure',
 109 'make', and 'make install'.  If a particular module you expected to be
 110 installed was not installed, then the output of the
 111 'configure;make;make install' sequence will tell you why that module
 112 was not installed.  Please do NOT post questions to the FreeRADIUS
 113 users list without carefully reading the output of this process.
 114
 115
 116 2. RUNNING THE SERVER
 117
 118   If the server builds and installs, but doesn't run correctly, then
 119 you may use debugging mode (radiusd -X) to figure out the problem.
 120
 121   This is your BEST HOPE for understanding the problem.  Read ALL of
 122 the messages which are printed to the screen, the answer to your
 123 problem will often be in a warning or error message.
 124
 125   We really can't emphasize that last sentence enough.  Configuring a
 126 RADIUS server for complex local authentication isn't a trivial task.
 127 Your ONLY method for debugging it is to read the debug messages, where
 128 the server will tell you exactly what it's doing, and why.  You should
 129 then compare its behaviour to what you intended, and edit the
 130 configuration files as appropriate.
 131
 132   If you don't use debugging mode, and ask questions on the mailing
 133 list, then the responses will all tell you to use debugging mode.  The
 134 server prints out a lot of information in this mode, including
 135 suggestions for fixes to common problems.  Look for "WARNING" in the
 136 output, and read the related messages.
 137
 138    Since the main developers of FreeRADIUS use debugging mode to track
 139 down their configuration problems with the server, it's a good idea
 140 for you to use it, too.  If you don't, there is little hope for you to
 141 solve ANY configuration problem related to the server.
 142
 143   To start the server in debugging mode, do:
 144
 145         $ radiusd -X
 146
 147   You should see a lot of text printed on the screen as it starts up.
 148 If you don't, or if you see error messages, please read the FAQ:
 149
 150         http://www.freeradius.org/faq/
 151
 152   If the server says "Ready to process requests.", then it is running
 153 properly.  From another shell (or another window), type:
 154
 155         $ radtest test test localhost 0 testing123
 156
 157   You should see the server print out more messages as it receives the
 158 request, and responds to it.  The 'radtest' program should receive the
 159 response within a few seconds.  It doesn't matter if the
 160 authentication request is accepted or rejected, what matters is that
 161 the server received the request, and responded to it.
 162
 163   You can now edit the 'radiusd.conf' file for your local system.
 164 Please read the ENTIRE file carefully, as many configuration options
 165 are only documented in comments in the file.
 166
 167   Configuring and running the server MAY be complicated.  Many modules
 168 have "man" pages.  See "man rlm_pap", or "man rlm_*" for information.
 169 Please read the documentation in the doc/ directory.  The comments in
 170 the configuration files also contain a lot of documentation.
 171
 172   If you have any additional issues, the FAQ is also a good place to
 173 check.