freeswan/INSTALL

   1 If you are a non-expert, you should not be working from this file.
   2 Instead, you should work from the HTML documentation, starting with
   3 the Introduction (see README).  The rest of this file is FOR EXPERTS ONLY.
   4
   5 doc/impl.notes discusses some expert-only side issues; doc/kernel.notes
   6 is some (old) notes on kernel-building fine points.
   7
   8 If you have used an earlier version, read the CHANGES and BUGS files.
   9
  10 0. You must configure and build your own Linux kernel first, and you
  11 preferably should boot it to confirm that it works.  Also, if humanly
  12 possible, configure and test your network(s) without IPsec first, to make
  13 sure packets really can get from one end to the other.  Also, your system
  14 now needs to have the GMP library, including any "GMP development" package
  15 as well as GMP itself; this is part of normal Linux distributions but
  16 often isn't installed unless you ask for it.  (Note, there is also a GPM
  17 library, which is completely unrelated to GMP despite the similar names.)
  18
  19 1. Do ONE of the following commands, depending on how you configure your
  20 kernel.  (This configures, builds, and installs IPsec, except it does not
  21 install the new kernel.  The kernel build includes "make dep clean".)
  22
  23         # pick one; does more than just configure!
  24         make menugo             # use menuconfig
  25         make xgo                # use xconfig
  26         make ogo                # use config
  27         make oldgo              # use oldconfig
  28
  29 Experimentally, you can substitute (e.g.) "menumod" and have only the
  30 kernel modules, not the whole kernel, rebuilt.  You must configure IPsec
  31 as a module for this to work.
  32
  33 2. IPsec-related configuration settings are under "Networking options".
  34 Most relevant things are now right by default.  Some seemingly-unrelated
  35 options get turned on automatically because IPsec needs them.  Beware that
  36 the 2.2.xx "advanced router" causes problems:  its "rp_filter" subsystem
  37 often must be turned off for IPsec to work, and just leaving the whole
  38 thing disabled is the simplest approach unless you know what you're doing.
  39 Turning "IPSEC Debugging Option" off may look attractive but is unwise.
  40
  41 3. Save the new configuration settings, even if you have made no changes;
  42 KLIPS will not be part of your kernel configuration without such a save.
  43
  44 4. Wait.  The compile and kernel build take a while, perhaps 15min on a
  45 200MHz PCI machine with 32MB and good disks.  No interaction is needed
  46 after the configuration save.  A report on kernel patching is left in the
  47 file out.kpatch; the kernel build output is left in out.kbuild.  Proper
  48 error checking is done at every step:  the make WILL STOP if something
  49 goes wrong (even in the Linux kernel Makefiles, which are careless about
  50 this themselves -- their output is caught and checked).
  51
  52 5. Most of the user-level utilities are now in /usr/local/lib/ipsec, with
  53 the "ipsec" command in /usr/local/sbin to provide easy access to the rest.
  54 (Our procedures generally assume that /usr/local/sbin is in your shell's
  55 search path.)  The manual pages are in /usr/local/man/man[1-8], mostly
  56 under names starting with "ipsec_".  The new kernel is built but not yet
  57 installed.  At boot time, KLIPS and Pluto will start automatically.
  58
  59 6. Install the new kernel.  *IF* kernel install on your system uses the
  60 kernel's own "make install" (and perhaps "make modules_install"), then as
  61 a convenience, you can do it from our top-level directory by:
  62
  63         make kinstall           # only if using kernel "make install" etc.
  64
  65 This is properly error-checked, and the output is left in out.kinstall.
  66
  67 7. Edit the /etc/ipsec.conf and /etc/ipsec.secrets configuration files as
  68 necessary (see doc/intro.html or the manpages).  The Makefile will not
  69 overwrite them if run again.
  70
  71 8. Reboot.
  72
  73 This file is RCSID $Id: INSTALL,v 1.107 2001/05/30 12:57:13 henry Exp $