/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: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
38
38
    "man -l mandos.8".
39
39
    
40
40
*** Mandos Server
41
 
    + GnuTLS 3.3          http://www.gnutls.org/
42
 
    + Avahi 0.6.16        http://www.avahi.org/
 
41
    + GnuTLS 3.3          https://www.gnutls.org/
 
42
      (but not 3.6.0 or later, until 3.6.6, which works)
 
43
    + Avahi 0.6.16        https://www.avahi.org/
43
44
    + Python 2.7          https://www.python.org/
44
 
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
45
 
    + PyGObject 2.14.2    https://developer.gnome.org/pygobject/
46
 
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
45
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
 
46
    + PyGObject 3.7.1     https://wiki.gnome.org/Projects/PyGObject
 
47
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
47
48
    + Urwid 1.0.1         http://urwid.org/
48
49
      (Only needed by the "mandos-monitor" tool.)
49
50
    
52
53
    + ssh-keyscan from OpenSSH http://www.openssh.com/
53
54
    
54
55
    Package names:
55
 
    avahi-daemon python python-avahi python-dbus python-gobject
56
 
    python-urwid pkg-config fping ssh-client
 
56
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
 
57
    fping ssh-client
57
58
    
58
59
*** Mandos Client
 
60
    + GNU C Library 2.17 https://gnu.org/software/libc/
 
61
    + GnuTLS 3.3        https://www.gnutls.org/
 
62
      (but not 3.6.0 or later, until 3.6.6 which works)
 
63
    + Avahi 0.6.16      https://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/
 
67
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
 
68
    + GLib 2.40         http://www.gtk.org/
 
69
    
 
70
    One of:
59
71
    + initramfs-tools 0.85i
60
72
                        https://tracker.debian.org/pkg/initramfs-tools
61
 
    + GnuTLS 3.3        http://www.gnutls.org/
62
 
    + Avahi 0.6.16      http://www.avahi.org/
63
 
    + GnuPG 1.4.9       https://www.gnupg.org/
64
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
65
 
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
73
    + dracut 044+241
 
74
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
66
75
    
67
76
    Strongly recommended:
68
77
    + OpenSSH           http://www.openssh.com/
69
78
    
70
79
    Package names:
71
 
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
72
 
    libgpgme11-dev pkg-config ssh
 
80
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
 
81
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
 
82
    libglib2.0-dev
73
83
 
74
84
* Installing the Mandos server
75
85
  
122
132
     
123
133
        # /usr/lib/mandos/plugins.d/mandos-client \
124
134
                --pubkey=/etc/keys/mandos/pubkey.txt \
125
 
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
135
                --seckey=/etc/keys/mandos/seckey.txt \
 
136
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
 
137
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
126
138
     
127
139
     This command should retrieve the password from the server,
128
140
     decrypt it, and output it to standard output.