/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-08 18:18:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908181849-ogydhr0m4axi3dnu
* INSTALL: More text.  Better text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
2
2
 
3
3
* Prerequisites
4
4
  
5
 
  Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
6
 
  
7
 
  The following libraries and packages are needed.  (It is possible
8
 
  that it might work with older versions of some of these, but these
9
 
  versions are confirmed to work.  Newer versions are almost certainly
10
 
  OK.)
11
 
  
12
 
** Documentation
13
 
   These are required to build the manual pages for both the server
14
 
   and client:
15
 
   
16
 
   + DocBook 4.5          http://www.docbook.org/
17
 
   + DocBook XSL stylesheets 1.71.0
 
5
** Operating System
 
6
   
 
7
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
 
8
   
 
9
   This is mostly for scripts to make sure that the client is
 
10
   installed and started in the initial RAM disk environment and that
 
11
   the initrd.img file is automatically made unreadable.  The programs
 
12
   themselves *could* be run in other distributions, but they *are*
 
13
   specific to GNU/Linux systems, and not intended to be portable to
 
14
   other Unix systems.
 
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
    + DocBook XSL stylesheets 1.71.0
18
29
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
19
 
  
20
 
** Mandos Server
21
 
   + GnuTLS 2.4           http://www.gnu.org/software/gnutls/
22
 
   + Avahi 0.6.16         http://www.avahi.org/
23
 
   + Python 2.4           http://www.python.org/
24
 
   + Python-GnuTLS 1.1.5  http://pypi.python.org/pypi/python-gnutls/
25
 
   + dbus-python 0.82.4   http://dbus.freedesktop.org/doc/dbus-python/
26
 
   + python-ctypes 1.0.0  http://pypi.python.org/pypi/ctypes
27
 
   
28
 
   Strongly recommended:
29
 
   + fping 2.4b2-to-ipv6  http://www.fping.com/
30
 
  
31
 
** Mandos Client
32
 
   + initramfs-tools 0.85i
 
30
    
 
31
    Package names:
 
32
    docbook docbook-xsl
 
33
   
 
34
*** Mandos Server
 
35
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
36
    + Avahi 0.6.16        http://www.avahi.org/
 
37
    + Python 2.4          http://www.python.org/
 
38
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
 
39
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
 
40
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
 
41
    
 
42
    Strongly recommended:
 
43
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
44
    
 
45
    Package names:
 
46
    python-gnutls avahi-daemon python2.5 python-avahi python-dbus
 
47
    python-ctypes
 
48
   
 
49
*** Mandos Client
 
50
    + initramfs-tools 0.85i
33
51
                  http://packages.qa.debian.org/i/initramfs-tools.html
34
 
   + GnuTLS 2.4           http://www.gnu.org/software/gnutls/
35
 
   + Avahi 0.6.16         http://www.avahi.org/
36
 
   + GnuPG 1.4.9          http://www.gnupg.org/
37
 
   + GPGME 1.1.6          http://www.gnupg.org/related_software/gpgme/
 
52
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
53
    + Avahi 0.6.16        http://www.avahi.org/
 
54
    + GnuPG 1.4.9         http://www.gnupg.org/
 
55
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
 
56
    
 
57
    Package names:
 
58
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
59
    libgpgme11-dev
38
60
 
39
61
* Installing the Mandos server
40
62
  
41
 
  + Do "make doc".
 
63
  1. Do "make doc".
42
64
  
43
 
  + On the computer to run as a Mandos server, run the following
44
 
    command: "sudo make install-server".
 
65
  2. On the computer to run as a Mandos server, run the following
 
66
     command: "sudo make install-server".
45
67
    
46
 
    (This creates a configuration without any clients configured; we
47
 
    need an actually configured client to do that; see below.)
 
68
     (This creates a configuration without any clients configured; we
 
69
     need an actually configured client to do that; see below.)
48
70
 
49
71
* Installing the Mandos client.
50
72
  
51
 
  + Do "make all doc".
52
 
  
53
 
  + On the computer to run as a Mandos server, run the following
54
 
    command: "sudo make install-client".  This will also create an
55
 
    OpenPGP key, which will take some time and entropy, so either wait
56
 
    patiently or frob your mouse until it's done.
57
 
  
58
 
  + Run "mandos-keygen --password".  When prompted, enter the
59
 
    password/passphrase for the encrypted root file system on this
60
 
    client computer.  It will output a section of text, starting with
61
 
    a [section header].  Copy and paste this into the
62
 
    "/etc/mandos/clients.conf" file *on the server computer*.
63
 
  
64
 
  + On the server computer, start the server by running the command
65
 
    "invoke-rc.d mandos start".
 
73
  1. Do "make all doc".
 
74
  
 
75
  2. On the computer to run as a Mandos client, run the following
 
76
     command: "sudo make install-client".  This will also create an
 
77
     OpenPGP key, which will take some time and entropy, so either
 
78
     wait patiently or frob your mouse until it's done.
 
79
  
 
80
  3. Run "mandos-keygen --password".  When prompted, enter the
 
81
     password/passphrase for the encrypted root file system on this
 
82
     client computer.  It will output a section of text, starting with
 
83
     a [section header].  Copy and paste this into the file
 
84
     "/etc/mandos/clients.conf" *on the server computer*.
 
85
  
 
86
  4. On the server computer, start the server by running the command
 
87
     "invoke-rc.d mandos start".
66
88
 
67
89
* Further customizations
68
90