/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 debian/mandos-client.README.Debian

  • Committer: Teddy Hogeborn
  • Date: 2019-04-10 20:33:13 UTC
  • Revision ID: teddy@recompile.se-20190410203313-d3ufer20hfws7i3h
Improve language in intro(8mandos) manual page

* intro.xml (INTRODUCTION): Replace "it" with "the data" to fix bad
                            reference, and clarify that it is the
                            client which continues booting.

Show diffs side-by-side

added added

removed removed

Lines of Context:
49
49
  setting is changed, it will be necessary to update the initrd image
50
50
  by running this command:
51
51
  
52
 
        (For initramfs-tools:)
53
52
        update-initramfs -k all -u
54
 
        
55
 
        (For dracut:)
56
 
        dpkg-reconfigure dracut
57
53
  
58
54
  The device can also be overridden at boot time on the Linux kernel
59
55
  command line using the sixth colon-separated field of the "ip="
64
60
  Note that since the network interfaces are used in the initial RAM
65
61
  disk environment, the network interfaces *must* exist at that stage.
66
62
  Thus, an interface can *not* be a pseudo-interface such as "br0" or
67
 
  "tun0"; instead, only real interfaces (such as "enp1s0" or "eth0")
68
 
  can be used. This can be overcome by writing a "network hook"
69
 
  program to create an interface (see mandos-client(8mandos)) and
70
 
  placing it in "/etc/mandos/network-hooks.d", from where it will be
71
 
  copied into the initial RAM disk.  Example network hook scripts can
72
 
  be found in "/usr/share/doc/mandos-client/examples/network-hooks.d".
 
63
  "tun0"; instead, only real interfaces (such as "eth0") can be used.
 
64
  This can be overcome by writing a "network hook" program to create
 
65
  an interface (see mandos-client(8mandos)) and placing it in
 
66
  "/etc/mandos/network-hooks.d", from where it will be copied into the
 
67
  initial RAM disk.  Example network hook scripts can be found in
 
68
  "/usr/share/doc/mandos-client/examples/network-hooks.d".
73
69
 
74
70
* User-Supplied Plugins
75
71
  
76
72
  Any plugins found in "/etc/mandos/plugins.d" will override and add
77
73
  to the normal Mandos plugins.  When adding or changing plugins, do
78
 
  not forget to update the initial RAM disk image:
 
74
  not forget to update the initital RAM disk image:
79
75
  
80
 
        (For initramfs-tools:)
81
76
        update-initramfs -k all -u
82
 
        
83
 
        (For dracut:)
84
 
        dpkg-reconfigure dracut
85
77
 
86
78
* Do *NOT* Edit "/etc/crypttab"
87
79
  
100
92
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
101
93
  line.
102
94
  
103
 
  For very advanced users, it is possible to specify "mandos=connect"
104
 
  on the kernel command line to make the system only set up the
105
 
  network (using the data in the "ip=" option) and not pass any extra
106
 
  "--connect" options to mandos-client at boot.  For this to work,
107
 
  "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs to be
108
 
  manually added to the file "/etc/mandos/plugin-runner.conf" or, if
109
 
  dracut is used with systemd, the "--connect=<ADDRESS>:<PORT>"
110
 
  options needs to be added to an environment variable in an override
111
 
  file for the "ask-password-mandos" service, as detailed in the file
112
 
  "/usr/lib/dracut/modules.d/90mandos/ask-password-mandos.service".
 
95
  For very advanced users, it is possible to specify simply
 
96
  "mandos=connect" on the kernel command line to make the system only
 
97
  set up the network (using the data in the "ip=" option) and not pass
 
98
  any extra "--connect" options to mandos-client at boot.  For this to
 
99
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
 
100
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
113
101
 
114
102
* Diffie-Hellman Parameters
115
103
 
116
104
  On installation, a file with Diffie-Hellman parameters,
117
105
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
118
 
  installed into the initial RAM disk image and also used by the
 
106
  installed into the initital RAM disk image and also used by the
119
107
  Mandos Client on boot.  If different parameters are needed for
120
108
  policy or other reasons, simply replace the existing dhparams.pem
121
 
  file and update the initial RAM disk image.
 
109
  file and update the initital RAM disk image.
122
110
 
123
 
 -- Teddy Hogeborn <teddy@recompile.se>, Sun,  8 Sep 2024 02:09:20 +0200
 
111
 -- Teddy Hogeborn <teddy@recompile.se>, Sat,  9 Feb 2019 15:08:04 +0100