/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Teddy Hogeborn
  • Date: 2008-09-21 14:05:44 UTC
  • mfrom: (24.1.103 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080921140544-e9qo7alcl0bne2mn
Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
 
1
-*- org -*-
 
2
 
 
3
* Prerequisites
 
4
  
 
5
** Operating System
 
6
   
 
7
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
 
8
   
 
9
   This is mostly for the support scripts which make sure that the
 
10
   client is installed and started in the initial RAM disk environment
 
11
   and that the initrd.img file is automatically made unreadable.  The
 
12
   server and client programs themselves *could* be run in other
 
13
   distributions, but they *are* specific to GNU/Linux systems, and
 
14
   are not intended to be portable to other Unixes.
 
15
  
 
16
** Libraries
 
17
   
 
18
   The following libraries and packages are needed.  (It is possible
 
19
   that it might work with older versions of some of these, but these
 
20
   versions are confirmed to work.  Newer versions are almost
 
21
   certainly OK.)
 
22
   
 
23
*** Documentation
 
24
    These are required to build the manual pages for both the server
 
25
    and client:
 
26
    
 
27
    + DocBook 4.5         http://www.docbook.org/
 
28
      Note: DocBook 5.0 is not compatible.
 
29
    + DocBook XSL stylesheets 1.71.0
 
30
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
 
31
    
 
32
    Package names:
 
33
    docbook docbook-xsl
 
34
    
 
35
    To build just the documentation, run the command "make doc".  Then
 
36
    the manual page "mandos.8", for example, can be read by running
 
37
    "man -l mandos.8".
 
38
   
 
39
*** Mandos Server
 
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
41
    + Avahi 0.6.16        http://www.avahi.org/
 
42
    + Python 2.4          http://www.python.org/
 
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
 
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
 
45
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
 
46
    
 
47
    Strongly recommended:
 
48
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
49
    
 
50
    Package names:
 
51
    python-gnutls avahi-daemon python python-avahi python-dbus
 
52
    python-ctypes
 
53
   
 
54
*** Mandos Client
 
55
    + initramfs-tools 0.85i
 
56
                  http://packages.qa.debian.org/i/initramfs-tools.html
 
57
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
58
    + Avahi 0.6.16        http://www.avahi.org/
 
59
    + GnuPG 1.4.9         http://www.gnupg.org/
 
60
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
 
61
    
 
62
    Package names:
 
63
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
64
    libgpgme11-dev
 
65
 
 
66
* Installing the Mandos server
 
67
  
 
68
  1. Do "make doc".
 
69
  
 
70
  2. On the computer to run as a Mandos server, run the following
 
71
     command:
 
72
     For Debian: su -c 'make install-server'
 
73
     For Ubuntu: sudo make install-server
 
74
     
 
75
     (This creates a configuration without any clients configured; you
 
76
     need an actually configured client to do that; see below.)
 
77
 
 
78
* Installing the Mandos client.
 
79
  
 
80
  1. Do "make all doc".
 
81
  
 
82
  2. On the computer to run as a Mandos client, run the following
 
83
     command:
 
84
     For Debian: su -c 'make install-client'
 
85
     For Ubuntu: sudo make install-client
 
86
     
 
87
     This will also create an OpenPGP key, which will take some time
 
88
     and entropy, so be patient.
 
89
  
 
90
  3. Run the following command:
 
91
     For Debian: su -c 'mandos-keygen --password'
 
92
     For Ubuntu: sudo mandos-keygen --password
 
93
     
 
94
     When prompted, enter the password/passphrase for the encrypted
 
95
     root file system on this client computer.  The command will
 
96
     output a section of text, starting with a [section header].  Copy
 
97
     and append this to the file "/etc/mandos/clients.conf" *on the
 
98
     server computer*.
 
99
  
 
100
  4. On the server computer, start the server by running the command
 
101
     For Debian: su -c 'invoke-rc.d mandos start'
 
102
     For Ubuntu: sudo invoke-rc.d mandos start
 
103
     
 
104
     After this, the client computer should be able to reboot without
 
105
     needing a password entered on the console, as long as it does not
 
106
     take more than an hour to reboot.
 
107
 
 
108
* Further customizations
 
109
  
 
110
  You may want to tighten or loosen the timeouts in the server
 
111
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
 
112
  Is IPsec is not used, it is suggested that a more cryptographically
 
113
  secure checker program is used and configured, since without IPsec
 
114
  ping packets can be faked.