/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: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
40
40
*** Mandos Server
41
41
    + GnuTLS 3.3          https://www.gnutls.org/
42
42
      (but not 3.6.0 or later, until 3.6.6, which works)
43
 
    + Avahi 0.6.16        http://www.avahi.org/
44
 
    + Python 2.7          https://www.python.org/
 
43
    + Avahi 0.6.16        https://www.avahi.org/
 
44
    + Python 3           https://www.python.org/
 
45
      Note: Python 2.7 is still supported, if the "mandos",
 
46
      "mandos-ctl", and "mandos-monitor" files are edited to contain
 
47
      "#!/usr/bin/python" instead of python3.
45
48
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
46
 
    + PyGObject 3.7.1     https://wiki.gnome.org/Projects/PyGObject
 
49
    + PyGObject 3.8      https://wiki.gnome.org/Projects/PyGObject
47
50
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
48
51
    + Urwid 1.0.1         http://urwid.org/
49
52
      (Only needed by the "mandos-monitor" tool.)
53
56
    + ssh-keyscan from OpenSSH http://www.openssh.com/
54
57
    
55
58
    Package names:
56
 
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
57
 
    fping ssh-client
 
59
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
 
60
    pkg-config fping ssh-client
58
61
    
59
62
*** Mandos Client
60
 
    + GNU C Library 2.16 https://gnu.org/software/libc/
61
 
    + initramfs-tools 0.85i
62
 
                        https://tracker.debian.org/pkg/initramfs-tools
 
63
    + GNU C Library 2.17 https://gnu.org/software/libc/
63
64
    + GnuTLS 3.3        https://www.gnutls.org/
64
65
      (but not 3.6.0 or later, until 3.6.6 which works)
65
 
    + Avahi 0.6.16      http://www.avahi.org/
 
66
    + Avahi 0.6.16      https://www.avahi.org/
66
67
    + GnuPG 1.4.9       https://www.gnupg.org/
67
68
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
68
69
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
70
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
 
71
    + GLib 2.40         http://www.gtk.org/
 
72
    
 
73
    One of:
 
74
    + initramfs-tools 0.85i
 
75
                        https://tracker.debian.org/pkg/initramfs-tools
 
76
    + dracut 044+241
 
77
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
69
78
    
70
79
    Strongly recommended:
71
80
    + OpenSSH           http://www.openssh.com/
72
81
    
73
82
    Package names:
74
 
    initramfs-tools libgnutls-dev gnutls-bin libavahi-core-dev gnupg
75
 
    libgpgme11-dev pkg-config ssh
 
83
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
 
84
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
 
85
    libglib2.0-dev
76
86
 
77
87
* Installing the Mandos server
78
88
  
80
90
  
81
91
  2. On the computer to run as a Mandos server, run the following
82
92
     command:
83
 
     For Debian: su -c 'make install-server'
 
93
     For Debian: su - -c 'make install-server'
84
94
     For Ubuntu: sudo make install-server
85
95
     
86
96
     (This creates a configuration without any clients configured; you
92
102
  
93
103
  2. On the computer to run as a Mandos client, run the following
94
104
     command:
95
 
     For Debian: su -c 'make install-client'
 
105
     For Debian: su - -c 'make install-client'
96
106
     For Ubuntu: sudo make install-client
97
107
     
98
108
     This will also create an OpenPGP key, which will take some time
99
109
     and entropy, so be patient.
100
110
  
101
111
  3. Run the following command:
102
 
     For Debian: su -c 'mandos-keygen --password'
 
112
     For Debian: su - -c 'mandos-keygen --password'
103
113
     For Ubuntu: sudo mandos-keygen --password
104
114
     
105
115
     When prompted, enter the password/passphrase for the encrypted
117
127
        # update-initramfs -k all -u
118
128
  
119
129
  5. On the server computer, start the server by running the command
120
 
     For Debian: su -c 'invoke-rc.d mandos start'
 
130
     For Debian: su - -c 'invoke-rc.d mandos start'
121
131
     For Ubuntu: sudo service mandos start
122
132
     
123
133
     At this point, it is possible to verify that the correct password