/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: 2018-02-08 10:23:55 UTC
  • Revision ID: teddy@recompile.se-20180208102355-3ent7sf87i9h9kka
Update copyright year to 2018

* DBUS-API: Update copyright year to 2018.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* network-hooks.d/bridge: - '' -
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat".
 
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
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 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 written with portabillity to other Unixes in mind.
 
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.
15
16
   
16
17
** Libraries
17
18
   
27
28
    + DocBook 4.5         http://www.docbook.org/
28
29
      Note: DocBook 5.0 is not compatible.
29
30
    + DocBook XSL stylesheets 1.71.0
30
 
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
 
31
                         http://wiki.docbook.org/DocBookXslStylesheets
31
32
    
32
33
    Package names:
33
34
    docbook docbook-xsl
37
38
    "man -l mandos.8".
38
39
    
39
40
*** Mandos Server
40
 
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
41
    + GnuTLS 3.3          https://www.gnutls.org/
41
42
    + Avahi 0.6.16        http://www.avahi.org/
42
 
    + Python 2.6          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
 
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
46
 
    + Urwid 0.9.8.3       http://excess.org/urwid/
 
43
    + Python 2.7          https://www.python.org/
 
44
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
 
45
    + PyGObject 3.7.1     https://wiki.gnome.org/Projects/PyGObject
 
46
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
47
    + Urwid 1.0.1         http://urwid.org/
 
48
      (Only needed by the "mandos-monitor" tool.)
47
49
    
48
50
    Strongly recommended:
49
 
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
51
    + fping 2.4b2-to-ipv6      http://www.fping.org/
50
52
    + ssh-keyscan from OpenSSH http://www.openssh.com/
51
53
    
52
54
    Package names:
53
 
    python-gnutls avahi-daemon python python-avahi python-dbus
54
 
    python-gobject python-urwid ssh-client
 
55
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
 
56
    fping ssh-client
55
57
    
56
58
*** Mandos Client
 
59
    + GNU C Library 2.16 https://gnu.org/software/libc/
57
60
    + initramfs-tools 0.85i
58
 
                  http://packages.qa.debian.org/i/initramfs-tools.html
59
 
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
60
 
    + Avahi 0.6.16        http://www.avahi.org/
61
 
    + GnuPG 1.4.9         http://www.gnupg.org/
62
 
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
 
61
                        https://tracker.debian.org/pkg/initramfs-tools
 
62
    + GnuTLS 3.3        https://www.gnutls.org/
 
63
    + Avahi 0.6.16      http://www.avahi.org/
 
64
    + GnuPG 1.4.9       https://www.gnupg.org/
 
65
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
66
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
63
67
    
64
68
    Strongly recommended:
65
 
    + OpenSSH             http://www.openssh.com/
 
69
    + OpenSSH           http://www.openssh.com/
66
70
    
67
71
    Package names:
68
72
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
69
 
    libgpgme11-dev ssh
 
73
    libgpgme11-dev pkg-config ssh
70
74
 
71
75
* Installing the Mandos server
72
76
  
102
106
     and append this to the file "/etc/mandos/clients.conf" *on the
103
107
     server computer*.
104
108
  
105
 
  4. Configure the client to use the correct network interface.  The
106
 
     interface to use is automatically chosen at boot, and if this
107
 
     needs to be adjusted, it will be necessary to edit
108
 
     /etc/initramfs-tools/initramfs.conf to change the DEVICE setting
109
 
     there.  Alternatively, the file /etc/mandos/plugin-runner.conf
110
 
     can be edited to add a "--device" parameter for the
111
 
     mandos-client(8) plugin.  Please note: If any of those files are
112
 
     changed, the initrd.img file must be updated, possibly using the
113
 
     following command:
 
109
  4. Configure the client to use any special configuration needed for
 
110
     your local system.  Note: This is not necessary if the server is
 
111
     present on the same wired local network as the client.  If you do
 
112
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
113
     file must be updated, possibly using the following command:
114
114
     
115
115
        # update-initramfs -k all -u
116
116
  
130
130
     
131
131
     After this, the client computer should be able to reboot without
132
132
     needing a password entered on the console, as long as it does not
133
 
     take more than an hour to reboot.
 
133
     take more than five minutes to reboot.
134
134
 
135
135
* Further customizations
136
136
  
139
139
  If IPsec is not used and SSH is not installed, it is suggested that
140
140
  a more cryptographically secure checker program is used and
141
141
  configured, since, without IPsec, ping packets can be faked.
 
142
 
 
143
#+STARTUP: showall