1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/debian/README.online	Fri Sep 26 17:05:23 2008 +0200
     1.3 @@ -0,0 +1,92 @@
     1.4 +Different methods for online detection
     1.5 +--------------------------------------
     1.6 +
     1.7 +/etc/ppp/peers/<provider>
     1.8 +-------------------------
     1.9 +
    1.10 +The scripts /etc/ppp/ip-{up,down}.d/{1,99}masqmail make use of the variable
    1.11 +$IPPARAM, which you can defibe in your /etc/ppp/peers/<provider>
    1.12 +configuration with the ippparam option, eg:
    1.13 +
    1.14 +ippparam arcor
    1.15 +
    1.16 +If this is set, $IPPARAM will be written to a 'route' file. Using some
    1.17 +awk magic, the scripts finds out which file you have defined for
    1.18 +online detection (if online_detect=file) and writes the value of
    1.19 +$IPPARAM to this file. masqmail then uses this file to determine its
    1.20 +online status.
    1.21 +
    1.22 +
    1.23 +/etc/network/interfaces
    1.24 +-----------------------
    1.25 +
    1.26 +You can use the /etc/network/interfaces script to tell masqmail
    1.27 +when a link goes up, and masqmail shall flush its queue and/or fetch mail.
    1.28 +
    1.29 +This is an example for a static interface:
    1.30 +
    1.31 +iface eth0 inet static
    1.32 +        # mroute/name used by ip-up.d/masqmail BDL May02
    1.33 +        name SNRC
    1.34 +        address 130.130.10.233
    1.35 +        netmask 255.255.255.0
    1.36 +        gateway 130.130.10.254
    1.37 +
    1.38 +(This example is from Ben Low. Thanks, Ben :-))
    1.39 +
    1.40 +If you use masqmail on a notebook, you can define several interfaces,
    1.41 +depending on the network you are in. Read
    1.42 +/usr/share/doc/ifupdown/examples/interfaces.gz
    1.43 +for examples.
    1.44 +
    1.45 +The scripts /etc/network/if-{up,down}.d/1masqmail make use of the NAME
    1.46 +in the same way as the /etc/ppp/ip-{up,down}.d/ scripts. See above.
    1.47 +
    1.48 +
    1.49 +guessnet and /etc/network/interfaces
    1.50 +------------------------------------
    1.51 +
    1.52 +Another nice tool is guessnet. See /usr/share/doc/guessnet/README.gz,
    1.53 +if you have guessnet installed. You can use it in combination with the
    1.54 +method described above for /etc/network/interfaces.
    1.55 +
    1.56 +
    1.57 +guessnet and the 'online_pipe' option
    1.58 +-------------------------------------
    1.59 +
    1.60 +Alternatively you can also use guessnet directly to check the online
    1.61 +status. To do this, set in
    1.62 +/etc/masqmail/masqmail.conf
    1.63 +
    1.64 +#
    1.65 +online_detect=pipe
    1.66 +online_pipe="/usr/bin/guessnet < /etc/masqmail/guessnet.conf"
    1.67 +#
    1.68 +
    1.69 +and create a file
    1.70 +/etc/masqmail/guessnet.conf
    1.71 +
    1.72 +Example:
    1.73 +192.168.0.35 00:10:5A:24:C5:B6 192.168.0.1 default
    1.74 +192.168.2.1 00:80:AD:97:D5:2D 192.168.0.1 home
    1.75 +
    1.76 +
    1.77 +masqdialer and the 'online_pipe' option
    1.78 +---------------------------------------
    1.79 +
    1.80 +Yet another possibility for ppp dialups is masqdialer:
    1.81 +
    1.82 +Example:
    1.83 +#
    1.84 +online_detect=pipe
    1.85 +online_pipe="/usr/bin/mservdetect 192.168.1.2 224"
    1.86 +#
    1.87 +
    1.88 +This is useful if you have a gateway with masqdialer running
    1.89 +and masqmail on another host behind ('behind' as seen from the internet)
    1.90 +
    1.91 +Note:
    1.92 +The online detect method 'mserver' is deprecated, and this debian
    1.93 +package comes with that option disabled. You can still recompile the
    1.94 +package with the ./configure option --enable-mserver, but this may be
    1.95 +removed in future version of masqmail.