/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: 2024-09-08 00:24:32 UTC
  • Revision ID: teddy@recompile.se-20240908002432-0exnlv1fp73hps8j
Document how to add options to mandos-client when using dracut

* debian/mandos-client.README.Debian: Remove unnecessary word
  "simply".  Also add instructions on how to add the --connect=
  options to mandos-client when using dracut.
* dracut-module/ask-password-mandos.service ([Service]): Add comments
  that this file should *not* be modified, and explicit instructions
  on how to instead add extra options, like --debug, to mandos-client:
  using a systemd override unit file to set an environment variable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/mandos-client.README.Debian
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:)
52
53
        update-initramfs -k all -u
 
54
        
 
55
        (For dracut:)
 
56
        dpkg-reconfigure dracut
53
57
  
54
58
  The device can also be overridden at boot time on the Linux kernel
55
59
  command line using the sixth colon-separated field of the "ip="
71
75
  
72
76
  Any plugins found in "/etc/mandos/plugins.d" will override and add
73
77
  to the normal Mandos plugins.  When adding or changing plugins, do
74
 
  not forget to update the initital RAM disk image:
 
78
  not forget to update the initial RAM disk image:
75
79
  
 
80
        (For initramfs-tools:)
76
81
        update-initramfs -k all -u
 
82
        
 
83
        (For dracut:)
 
84
        dpkg-reconfigure dracut
77
85
 
78
86
* Do *NOT* Edit "/etc/crypttab"
79
87
  
92
100
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
93
101
  line.
94
102
  
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".
 
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".
101
113
 
102
114
* Diffie-Hellman Parameters
103
115
 
104
116
  On installation, a file with Diffie-Hellman parameters,
105
117
  /etc/keys/mandos/dhparams.pem, will be generated and automatically
106
 
  installed into the initital RAM disk image and also used by the
 
118
  installed into the initial RAM disk image and also used by the
107
119
  Mandos Client on boot.  If different parameters are needed for
108
120
  policy or other reasons, simply replace the existing dhparams.pem
109
 
  file and update the initital RAM disk image.
 
121
  file and update the initial RAM disk image.
110
122
 
111
 
 -- Teddy Hogeborn <teddy@recompile.se>, Thu, 20 Jun 2019 20:28:25 +0200
 
123
 -- Teddy Hogeborn <teddy@recompile.se>, Sun,  8 Sep 2024 02:09:20 +0200