/mandos/release

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

« back to all changes in this revision

Viewing changes to INSTALL

* plugin-runner.c: Comment change.

* plugins.d/mandos-client.c: Comment changes.
  (quit_now): New global flag.
  (handle_sigterm): Only call avahi_simple_poll_quit once.
  (main): Also handle SIGINT and SIGHUP.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat" (or later).
 
7
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
8
8
   
9
9
   This is mostly for the support scripts which make sure that the
10
10
   client is installed and started in the initial RAM disk environment
11
 
   and that the initial RAM file system image file is automatically
12
 
   made unreadable.  The server and client programs themselves *could*
13
 
   be run in other distributions, but they *are* specific to GNU/Linux
14
 
   systems, and are not written with portabillity to other Unixes in
15
 
   mind.
16
 
   
 
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
  
17
16
** Libraries
18
17
   
19
18
   The following libraries and packages are needed.  (It is possible
28
27
    + DocBook 4.5         http://www.docbook.org/
29
28
      Note: DocBook 5.0 is not compatible.
30
29
    + DocBook XSL stylesheets 1.71.0
31
 
                         http://wiki.docbook.org/DocBookXslStylesheets
 
30
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
32
31
    
33
32
    Package names:
34
33
    docbook docbook-xsl
36
35
    To build just the documentation, run the command "make doc".  Then
37
36
    the manual page "mandos.8", for example, can be read by running
38
37
    "man -l mandos.8".
39
 
    
 
38
   
40
39
*** Mandos Server
41
 
    + GnuTLS 2.4          http://www.gnutls.org/
42
 
      Note: GnuTLS 3 will only work with Python-GnuTLS 2
 
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
43
41
    + Avahi 0.6.16        http://www.avahi.org/
44
 
    + Python 2.7          https://www.python.org/
45
 
    + Python-GnuTLS 1.1.5 https://pypi.python.org/pypi/python-gnutls/
 
42
    + Python 2.4          http://www.python.org/
 
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
46
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
47
 
    + PyGObject 2.14.2    https://developer.gnome.org/pygobject/
48
 
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
49
 
    + Urwid 1.0.1         http://urwid.org/
50
 
      (Only needed by the "mandos-monitor" tool.)
 
45
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
 
46
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
51
47
    
52
48
    Strongly recommended:
53
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
54
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
55
50
    
56
51
    Package names:
57
52
    python-gnutls avahi-daemon python python-avahi python-dbus
58
 
    python-gobject python-urwid pkg-config fping ssh-client
59
 
    
 
53
    python-ctypes python-gobject
 
54
   
60
55
*** Mandos Client
61
56
    + initramfs-tools 0.85i
62
 
                        https://tracker.debian.org/pkg/initramfs-tools
63
 
    + GnuTLS 2.4        http://www.gnutls.org/
64
 
    + Avahi 0.6.16      http://www.avahi.org/
65
 
    + GnuPG 1.4.9       https://www.gnupg.org/
66
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
67
 
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
68
 
    
69
 
    Strongly recommended:
70
 
    + OpenSSH           http://www.openssh.com/
 
57
                  http://packages.qa.debian.org/i/initramfs-tools.html
 
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/
71
62
    
72
63
    Package names:
73
64
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
74
 
    libgpgme11-dev pkg-config ssh
 
65
    libgpgme11-dev
75
66
 
76
67
* Installing the Mandos server
77
68
  
107
98
     and append this to the file "/etc/mandos/clients.conf" *on the
108
99
     server computer*.
109
100
  
110
 
  4. Configure the client to use any special configuration needed for
111
 
     your local system.  Note: This is not necessary if the server is
112
 
     present on the same wired local network as the client.  If you do
113
 
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
101
  4. Configure the client to use the correct network interface.  The
 
102
     default is "eth0", and if this needs to be adjusted, it will be
 
103
     necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
 
104
     change the line there.  If that file is changed, the initrd.img
114
105
     file must be updated, possibly using the following command:
115
106
     
116
107
        # update-initramfs -k all -u
117
108
  
118
109
  5. On the server computer, start the server by running the command
119
110
     For Debian: su -c 'invoke-rc.d mandos start'
120
 
     For Ubuntu: sudo service mandos start
 
111
     For Ubuntu: sudo invoke-rc.d mandos start
121
112
     
122
113
     At this point, it is possible to verify that the correct password
123
114
     will be received by the client by running the command:
131
122
     
132
123
     After this, the client computer should be able to reboot without
133
124
     needing a password entered on the console, as long as it does not
134
 
     take more than five minutes to reboot.
 
125
     take more than an hour to reboot.
135
126
 
136
127
* Further customizations
137
128
  
138
129
  You may want to tighten or loosen the timeouts in the server
139
130
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
140
 
  If IPsec is not used and SSH is not installed, it is suggested that
141
 
  a more cryptographically secure checker program is used and
142
 
  configured, since, without IPsec, ping packets can be faked.
143
 
 
144
 
#+STARTUP: showall
 
131
  If IPsec is not used, it is suggested that a more cryptographically
 
132
  secure checker program is used and configured, since without IPsec
 
133
  ping packets can be faked.