/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: 2012-05-01 20:07:28 UTC
  • Revision ID: teddy@recompile.se-20120501200728-tv1dn5uern8jshyn
* mandos (Client.stop_checker): Use new Popen.terminate() method.

Show diffs side-by-side

added added

removed removed

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