/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
179 by Teddy Hogeborn
* INSTALL: New file.
1
-*- org -*-
2
3
* Prerequisites
4
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
5
** Operating System
6
   
237.7.20 by Teddy Hogeborn
* INSTALL: Updated.
7
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat".
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
8
   
181 by Teddy Hogeborn
* INSTALL: Even better text.
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
237.7.20 by Teddy Hogeborn
* INSTALL: Updated.
14
   are not written with portabillity to other Unixes in mind.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
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/
181 by Teddy Hogeborn
* INSTALL: Even better text.
28
      Note: DocBook 5.0 is not compatible.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
29
    + DocBook XSL stylesheets 1.71.0
179 by Teddy Hogeborn
* INSTALL: New file.
30
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
31
    
32
    Package names:
33
    docbook docbook-xsl
181 by Teddy Hogeborn
* INSTALL: Even better text.
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".
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
38
   
39
*** Mandos Server
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
41
    + Avahi 0.6.16        http://www.avahi.org/
237.7.20 by Teddy Hogeborn
* INSTALL: Updated.
42
    + Python 2.6          http://www.python.org/
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
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/
237.2.50 by Teddy Hogeborn
* INSTALL (Prerequisites/Mandos Server): Added "PyGObject".
45
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
237.7.20 by Teddy Hogeborn
* INSTALL: Updated.
46
    + Urwid 0.9.8.3       http://excess.org/urwid/
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
47
    
48
    Strongly recommended:
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
50
    
51
    Package names:
181 by Teddy Hogeborn
* INSTALL: Even better text.
52
    python-gnutls avahi-daemon python python-avahi python-dbus
237.7.20 by Teddy Hogeborn
* INSTALL: Updated.
53
    python-gobject python-urwid
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
54
   
55
*** Mandos Client
56
    + initramfs-tools 0.85i
179 by Teddy Hogeborn
* INSTALL: New file.
57
                  http://packages.qa.debian.org/i/initramfs-tools.html
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
58
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
59
    + Avahi 0.6.16        http://www.avahi.org/
60
    + GnuPG 1.4.9         http://www.gnupg.org/
61
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
62
    
63
    Package names:
64
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
65
    libgpgme11-dev
179 by Teddy Hogeborn
* INSTALL: New file.
66
67
* Installing the Mandos server
68
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
69
  1. Do "make doc".
179 by Teddy Hogeborn
* INSTALL: New file.
70
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
71
  2. On the computer to run as a Mandos server, run the following
181 by Teddy Hogeborn
* INSTALL: Even better text.
72
     command:
73
     For Debian: su -c 'make install-server'
74
     For Ubuntu: sudo make install-server
75
     
76
     (This creates a configuration without any clients configured; you
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
77
     need an actually configured client to do that; see below.)
179 by Teddy Hogeborn
* INSTALL: New file.
78
79
* Installing the Mandos client.
80
  
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
81
  1. Do "make all doc".
82
  
83
  2. On the computer to run as a Mandos client, run the following
181 by Teddy Hogeborn
* INSTALL: Even better text.
84
     command:
85
     For Debian: su -c 'make install-client'
86
     For Ubuntu: sudo make install-client
87
     
88
     This will also create an OpenPGP key, which will take some time
89
     and entropy, so be patient.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
90
  
181 by Teddy Hogeborn
* INSTALL: Even better text.
91
  3. Run the following command:
92
     For Debian: su -c 'mandos-keygen --password'
93
     For Ubuntu: sudo mandos-keygen --password
94
     
95
     When prompted, enter the password/passphrase for the encrypted
96
     root file system on this client computer.  The command will
97
     output a section of text, starting with a [section header].  Copy
98
     and append this to the file "/etc/mandos/clients.conf" *on the
99
     server computer*.
180 by Teddy Hogeborn
* INSTALL: More text. Better text.
100
  
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
101
  4. Configure the client to use the correct network interface.  The
237.7.20 by Teddy Hogeborn
* INSTALL: Updated.
102
     interface to use is automatically chosen at boot, and if this
103
     needs to be adjusted, it will be necessary to edit
104
     /etc/initramfs-tools/initramfs.conf to change the DEVICE setting
105
     there.  Alternatively, the file /etc/mandos/plugin-runner.conf
106
     can be edited to add a "--device" parameter for the
107
     mandos-client(8) plugin.  Please note: If any of those files are
108
     changed, the initrd.img file must be updated, possibly using the
109
     following command:
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
110
     
111
	# update-initramfs -k all -u
112
  
113
  5. On the server computer, start the server by running the command
181 by Teddy Hogeborn
* INSTALL: Even better text.
114
     For Debian: su -c 'invoke-rc.d mandos start'
237.7.20 by Teddy Hogeborn
* INSTALL: Updated.
115
     For Ubuntu: sudo service mandos start
181 by Teddy Hogeborn
* INSTALL: Even better text.
116
     
228 by Teddy Hogeborn
* INSTALL: Add instructions on how to set the correct network
117
     At this point, it is possible to verify that the correct password
118
     will be received by the client by running the command:
119
     
120
	# /usr/lib/mandos/plugins.d/mandos-client \
121
		--pubkey=/etc/keys/mandos/pubkey.txt \
122
		--seckey=/etc/keys/mandos/seckey.txt; echo
123
     
124
     This command should retrieve the password from the server,
125
     decrypt it, and output it to standard output.
126
     
181 by Teddy Hogeborn
* INSTALL: Even better text.
127
     After this, the client computer should be able to reboot without
128
     needing a password entered on the console, as long as it does not
129
     take more than an hour to reboot.
179 by Teddy Hogeborn
* INSTALL: New file.
130
131
* Further customizations
132
  
133
  You may want to tighten or loosen the timeouts in the server
134
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
235 by Teddy Hogeborn
* INSTALL: Fixed typo.
135
  If IPsec is not used, it is suggested that a more cryptographically
179 by Teddy Hogeborn
* INSTALL: New file.
136
  secure checker program is used and configured, since without IPsec
137
  ping packets can be faked.