README

   1 #
   2 #   $Id$
   3 #    vi:set filetype=conf:
   4 #
   5
   6 WiFi Radar
   7 --------------------------------------------------------------------------------
   8
   9     Maintained by Brian Elliott Finley <brian@thefinleys.com>
  10     Created by Ahmad Baitalmal <ahmad@baitalmal.com>
  11
  12     http://wifi-radar.systemimager.org/
  13
  14     WiFi Radar is released under the GPL license.
  15
  16
  17 Quick Usage
  18 --------------------------------------------------------------------------------
  19
  20     To do a quick scan and connect to any available profile:
  21
  22         sudo wifi-radar -d
  23
  24
  25         To show the GUI and manage profiles:
  26
  27             sudo wifi-radar
  28
  29
  30 Nifty Config Tip for Ubuntu and Debian Based Distributions
  31 --------------------------------------------------------------------------------
  32
  33     After initial configuration of your preferred wifi networks by
  34     runing the wifi-radar GUI, you can automatically invoke wifi-radar
  35     as part of your systems standard ifup/ifdown proceedures.
  36
  37     Find a stanza in /etc/network/interfaces for your wifi device (or
  38     create one), and modify it so that it looks like this example:
  39
  40     auto eth1
  41     iface eth1 inet static
  42         address 0.0.0.1
  43         netmask 255.255.255.0
  44         post-up wifi-radar -d
  45
  46     When you or your system does an "ifup eth1", this stanza will set a
  47     temporary static IP address (that should not conflict with
  48     anything), then invoke wifi-radar in daemon mode which will connect
  49     to a preferred wifi network and configure your interface
  50     accordingly, with an IP address appropriate for that network.
  51
  52
  53
  54 I. Here are Some Important Bits:
  55 --------------------------------------------------------------------------------
  56
  57     * The config file defaults to /etc/wifi-radar/wifi-radar.conf.  The
  58       location of this file can be changed at install time with
  59       something like:
  60
  61         "make install sysconfdir=/etc/wifi-radar"
  62
  63     * If the conf file does not exist, it will be created at run-time, so you must
  64       always invoke wifi-radar as root or with sudo.
  65
  66     * Running wifi-radar with the "--daemon" or "-d" option will set it
  67       to "scan and auto connect" mode, which has no UI (good for running
  68       at boot time or in the background).
  69
  70     * You can change everything else from the conf file which is simply
  71       a .ini style file.
  72
  73     If you have questions, post them to the Linux Forum at the X1000
  74     Forums site (http://www.x1000forums.com/index.php?showforum=8).
  75
  76
  77 II. Dependencies
  78 --------------------------------------------------------------------------------
  79
  80     * Python
  81     * pygtk2
  82
  83
  84 III. Install
  85 --------------------------------------------------------------------------------
  86
  87     1. Type "sudo make install"
  88        (or "sudo make install sysconfdir=/etc/wifi-radar")
  89
  90
  91 IV. HOWTO: Optional PAM Configuration
  92 --------------------------------------------------------------------------------
  93
  94     These instructions allow you to run wifi-radar as a normal user
  95     without using sudo.  Thanks to Flipp Bunts <flipp.bunts@gmail.com>
  96     for this HOWTO.
  97
  98         HOWTO get wifi-radar custom launcher to use PAM authentication in
  99     Gnome:
 100         1. get wifi-radar and untar
 101         2. put wifi-radar.svg in /usr/share/pixmaps
 102         3. put wifi-radar.py in /usr/local/bin
 103         4. ln -s /usr/bin/consolehelper /usr/local/bin/wifi-radar
 104         5. vi /etc/security/console.apps/wifi-radar
 105                 USER=root
 106                 PROGRAM=/usr/local/bin/wifi-radar.py
 107                 SESSION=true
 108         6. vi /etc/pam.d/wifi-radar
 109                 #%PAM-1.0
 110                 auth       sufficient   pam_rootok.so
 111                 auth       sufficient   pam_timestamp.so
 112                 auth       required     pam_stack.so service=system-auth
 113                 session    required     pam_permit.so
 114                 session    optional     pam_xauth.so
 115                 session    optional     pam_timestamp.so
 116                 account    required     pam_permit.so
 117         7. check the permissions
 118                 # ls -lh /etc/security/console.apps/wifi-radar /etc/pam.d/wifi-radar
 119                 -rw-r--r--  1 root root  /etc/pam.d/wifi-radar
 120                 -rw-r--r--  1 root root  /etc/security/console.apps/wifi-radar
 121         8. add launcher
 122                 a. right click on panel
 123                 b. select 'add to panel'
 124                 c. click on 'custom application launcher'
 125                 d. options for 'create launcher'
 126                 name : wifi-radar
 127                 command : /usr/local/bin/wifi-radar
 128                 icon : /usr/share/pixmap/wifi-radar.svg
 129         9. click on the icon, enter the root password, away you go
 130
 131
 132 Have fun!
 133
 134
 135