/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to debian/mandos-client.README.Debian

Merge in branch to interpret an empty device name to mean
"autodetect".

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
* Choose the Client Network Interface
 
2
  
 
3
  You MUST make sure that the correct network interface is specified
 
4
  in the DEVICE setting in the "/etc/initramfs-tools/initramfs.conf"
 
5
  file.  *If* this is changed, it will be necessary to update the
 
6
  initrd image by running the command
 
7
  
 
8
        update-initramfs -k all -u
 
9
  
 
10
  The device can be overridden at boot time on the Linux kernel
 
11
  command line using the sixth colon-separated field of the "ip="
 
12
  option; for exact syntax, read the documentation in the file
 
13
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
 
14
  available in the "linux-doc-*" package.
 
15
  
 
16
  Note that since this network interface is used in the initial RAM
 
17
  disk environment, the network interface *must* exist at that stage.
 
18
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
 
19
  "tun0"; instead, a real interface (such as "eth0") must be used.
 
20
 
1
21
* Adding a Client Password to the Server
2
22
  
3
23
  The server must be given a password to give back to the client on
24
44
  it, and output it to standard output.  There it can be verified to
25
45
  be the correct password, before rebooting.
26
46
 
27
 
* Emergency Escape
28
 
  
29
 
  If it ever should be necessary, the Mandos client can be temporarily
30
 
  prevented from running at startup by passing the parameter
31
 
  "mandos=off" to the kernel.
32
 
 
33
 
* Specifying a Client Network Interface
34
 
  
35
 
  At boot time the network interface to use will by default be
36
 
  automatically detected.  If should result in an incorrect interface,
37
 
  edit the DEVICE setting in the "/etc/initramfs-tools/initramfs.conf"
38
 
  file.  (The default setting is empty, meaning to autodetect the
39
 
  interface.)  *If* the DEVICE setting is changed, it will be
40
 
  necessary to update the initrd image by running the command
41
 
  
42
 
        update-initramfs -k all -u
43
 
  
44
 
  The device can be overridden at boot time on the Linux kernel
45
 
  command line using the sixth colon-separated field of the "ip="
46
 
  option; for exact syntax, read the documentation in the file
47
 
  "/usr/share/doc/linux-doc-*/Documentation/filesystems/nfsroot.txt",
48
 
  available in the "linux-doc-*" package.
49
 
  
50
 
  Note that since this network interface is used in the initial RAM
51
 
  disk environment, the network interface *must* exist at that stage.
52
 
  Thus, the interface can *not* be a pseudo-interface such as "br0" or
53
 
  "tun0"; instead, only real interface (such as "eth0") can be used.
54
 
  This can be overcome by writing a "network hook" program to create
55
 
  the interface (see mandos-client(8mandos)) and placing it in
56
 
  "/etc/mandos/network-hooks.d", from where it will be copied into the
57
 
  initial RAM disk.  Example network hook scripts can be found in
58
 
  "/usr/share/doc/mandos-client/network-hooks.d".
59
 
 
60
47
* User-Supplied Plugins
61
48
  
62
49
  Any plugins found in "/etc/mandos/plugins.d" will override and add
73
60
  Mandos client will be the new default way for getting a password for
74
61
  the root file system when booting.
75
62
 
 
63
* Emergency Escape
 
64
  
 
65
  If it ever should be necessary, the Mandos client can be temporarily
 
66
  prevented from running at startup by passing the parameter
 
67
  "mandos=off" to the kernel.
 
68
 
76
69
* Non-local Connection (Not Using ZeroConf)
77
70
  
78
71
  If the "ip=" kernel command line option is used to specify a
79
72
  complete IP address and device name, as noted above, it then becomes
80
73
  possible to specify a specific IP address and port to connect to,
81
74
  instead of using ZeroConf.  The syntax for doing this is
82
 
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>" on the kernel command
83
 
  line.
 
75
  "mandos=connect:<IP_ADDRESS>:<PORT_NUMBER>".
 
76
  
 
77
  Warning: this will cause the client to make exactly one attempt at
 
78
  connecting, and then fail if it does not succeed.
84
79
  
85
80
  For very advanced users, it it possible to specify simply
86
81
  "mandos=connect" on the kernel command line to make the system only
89
84
  work, "--options-for=mandos-client:--connect=<ADDRESS>:<PORT>" needs
90
85
  to be manually added to the file "/etc/mandos/plugin-runner.conf".
91
86
 
92
 
 -- Teddy Hogeborn <teddy@recompile.se>, Mon, 28 Nov 2011 23:07:22 +0100
 
87
 -- Teddy Hogeborn <teddy@fukt.bsnet.se>, Tue,  8 Sep 2009 08:25:58 +0200