new web pages for bug reporting and donations
[wifi-assistant] / www / index.html
index c3fa145..01d0603 100644 (file)
@@ -1,6 +1,13 @@
 <html>
 <head>
 <title>Wifi Jail Breakout Assistant</title>
+<style>
+h2 { clear: both; }
+.screenshot { width: 400px; }
+dd { margin-bottom: 1em; }
+#roadmap .done { text-decoration: line-through }
+.cli { margin-left: 3em; }
+</style>
 </head>
 <body>
 
 <h1>Wifi Jail Breakout Assistant</h1>
 </div>
 
+
+
+
+
 <h2>About</h2>
 <h3>What?</h3>
 <p>
-This application aims to help to make life easier when connecting your Nokia N900 to wifi networks (wlan) that
- requires you to visit a captive portal page before you can access the Internet.
+This application aims to help make life easier when connecting your Nokia N900 to wifi networks (WLAN) that
+requires you to visit a captive portal (login) page before you can access the Internet.
 </p>
 
 <h3>Why?</h3>
@@ -22,6 +33,10 @@ I got tired of not being able to connect easily to networks guarded by a login p
 Nokia doesn't supply this feature and when asked for, it's out of scope for the N900.
 </p>
 
+
+
+
+
 <h2>How it works and Screenshots</h2>
 <h3>Connected to network</h3>
 <p>
@@ -29,7 +44,7 @@ When you're connected to a "new" network, you get this popup which asks you if y
 Simply press Yes or No to open a new browser window.
 The next time you connect to that network, the same action will be take (open or not open a browser window), 
 unless you untick the "Remember this decision" checkbox. (You'd get the same popup each time instead.)
-<div><img src='gfx/screenshot-popup.jpg' /></div>
+<div><img class='screenshot' src='gfx/screenshot-popup.jpg' /></div>
 </p>
 
 <h3>Network Settings</h3>
@@ -37,51 +52,120 @@ unless you untick the "Remember this decision" checkbox. (You'd get the same pop
 If you fire up the configuration/settings GUI (it's called Wifi Assistant and the icon looks like the one at the top this page) 
 you get a list of all the networks we've used and whether to launch a browser or not.
 You can change the settings by tapping the line you want to change.
-<div><img src='gfx/screenshot-launch-list.png' /></div>
-<div><img src='gfx/screenshot-launch-settings.png' /></div>
+<div><img class='screenshot' src='gfx/screenshot-launch-list.png' /></div>
+<div><img class='screenshot' src='gfx/screenshot-launch-settings.png' /></div>
 </p>
 
 <h3>Daemon Settings</h3>
 <p>
 You can turn the daemon off (kind of) so that it won't show popups. It'll still open a new browser window when you connect to
 networks where you've selected "Yes" previously. 
-<div><img src='gfx/screenshot-daemon-settings.png' /></div>
+<div><img class='screenshot' src='gfx/screenshot-daemon-settings.png' /></div>
 </p>
 
+
+
+
 <h2>Download and Install</h2>
 <p>
 Get the debian package file (wifi-assistant_X.X.X_all.deb) from 
-<a href="https://garage.maemo.org/frs/?group_id=1777">the Files section</a>
-at 
-<a href="https://garage.maemo.org/projects/wifi-assistant">this projects' garage (home)</a>.
-If you download the file using your browser, the phone  
+<a href="http://maemo.org/packages/view/wifi-assistant/">the Maemo.org packages site</a>
+If you download the file using your browser, the application manager will start and you'll be asked to install the pacakge.
 </p>
-
-<h2>License</h2>
 <p>
-This application is free to use, inspect, adapt and share, licensed under a BSD type license.
+Eventually you'll be able to download Wifi Assistant from the Extras repository, provided by Nokia/Maemo.
 </p>
+<p>
+If you want to use the terminal, the commands are (requires root shell (rootsh) and wget):
+<pre class='cli'>
+$ sudo gainroot
+# wget https.....
+# dpkg -i wifi-assistant_latest.deb
+</pre>
+</p>
+
+<h3>Alternative</h3>
+<p>
+You could also get the latest version from
+<a href="https://garage.maemo.org/projects/wifi-assistant">this projects' garage (home)</a>.
+This is where I put the packages I test myself. It should not differ at all from the ones
+built by the Maemo build site.
+</p> 
+
+
+
 
+<a name='roadmap'><!-- #roadmap --></a>
+<h2>Roadmap</h2>
+<ul id='roadmap'>
+       <li class='done'>Daemon that launches browser</li>
+       <li class='done'>GUI app where you can change settings</li>
+       <li class='done'>Add and remove settings</li>
+       <li>Upload wifi-assistant to Extras, <span class='done'put up a note on maemo.org forum</span></li>
+       <li>Handles SSID/Network names with spaces in them</li>
+       <li>Ability to specify URL to launch, per SSID/Network name</li>
+       <li>Detect if the net is locked down or not
+       (useful for networks which gives you one day access - you only want the browser launched once per day)</li>
+       <li>Have the network settings sorted alphabetically</li>
+       <li>Daemon work:
+               <ul>
+               <li>Let the GUI app launch daemon if it's not running</li>
+               <li>Change listenting to changes in gconf to using dbus</li>
+               </ul>
+       </li>
+       <li>Implement Ideas (below)</li>
+</ul>
+
+
+
+
+<a name='bugs'><!-- #bugs --></a>
 <h2>Bugs</h2>
 <p>
 Comes included from the start ...
 </p>
 <p>
-There's no grand bug tracking system setup for this project. If the application doesn't work as expected, 
-feel free to send me an e-mail, or post a message in 
-<a href="https://garage.maemo.org/forum/forum.php?forum_id=6070">the forum</a>
-here at garage.maemo.org.
+If you've found a bug I'd love to hear about it and have it fixed so the application improves!
+There are basically three way in which you can contribute:
+</p>
+<ul>
+<li>Send me an email (fredrik&#64;wendt&#46;se)</li>
+<li>Put up a post about it <a href="http://talk.maemo.org/showpost.php?p=782524">on this thread</a> at talk.maemo.org (a forum)</li>
+<li>Enter a bug or feature request in the <a href="https://bugs.maemo.org/enter_bug.cgi?product=Wifi%20Assistant">bug tracking system</a></li>
+</ul>
+<p>
+Either way - your contribution is greatly appreciated!
 </p>
 <p>
 The only real "bug" right now is that network names with spaces in them aren't handled properly (they can't be part of a gconf key).
 </p>
 
+
+
+
+<a name='source'><!-- #source --></a>
 <h2>Source</h2>
 <p>
-Is available, get it with <code>git clone https://vcs.maemo.org/git/wifi-assistant</code> or 
-<a href="https://garage.maemo.org/plugins/ggit/browse.php/?p=wifi-assistant">you could browse it online</a>. 
+It's all written in Python and the source is available for download - you can either get it with 
+<code>git clone https://vcs.maemo.org/git/wifi-assistant</code> or 
+<a href="https://garage.maemo.org/plugins/ggit/browse.php/?p=wifi-assistant">browse it online</a>. 
 There's more info at the <a href="https://garage.maemo.org/scm/?group_id=1777">SCM page</a>.
 </p>
+<p>
+Contributions are of course very welcome!
+</p>
+
+
+
+
+<a name='license'><!-- #license --></a>
+<h2>License</h2>
+<p>
+This application is free to use, inspect, adapt and share, licensed under a BSD type license.
+</p>
+
+
+
 
 <h2>Thanks</h2>
 <p>
@@ -89,10 +173,13 @@ To Lisa, Anton and Leia who support me (kind of) while I'm up late etc.
 </p>
 <p>
 A big thanks to Andrew Flegg (Jaffa) - the build files for this application are extremely similar 
-to those used for the excellent anti-blue man syndrome application 
+to those used to build the excellent anti "blue man syndrome" application 
 <a href='http://hermes.garage.maemo.org/'>Hermes</a>.
 </p>
 
+
+
+
 <h2>Donate</h2>
 <div style='margin-right: 1em; float: left'>
 <script type="text/javascript">
@@ -111,5 +198,45 @@ to those used for the excellent anti-blue man syndrome application
 </div>
 
 <p>
-You could either simply donate to PayPal, or Flattr this project - either way: thanks for your support!
+You could either simply donate via PayPal, or Flattr this project - either way: thanks for your support!
 </p>
+
+
+
+
+<a name='ideas'><!-- #ideas --></a>
+<h2>Ideas</h2>
+<dl>
+<dt>Detect login page when connected to new network</dt>
+<dd>This is fairly easy to do - simply make a HTTP HEAD request for a known static resource on the web. 
+If you get anything but a HTTP 200 in return, that network has a captive portal (or the connection was lost etc).</dd>
+
+<dt>Detect URL needed to autologin</dt>
+<dd>The best idea I have right now is to setup a local proxy. The way to operate this would be to:
+<ol>
+<li>"Open browser and record URLs" button clicked</li>
+<li>a HTTP proxy is setup, the browser is setup to use that proxy</li>
+<li>browser is launched</li>
+<li>user logs in at the portal page</li>
+<li>user switches to Wifi Assistant, clicks "Turn off URL recording"</li>
+<li>proxy is shut down, browser (system) settings reverted to previous settings</li>
+<li>user looks at list of recorded URLs</li>
+<li>user selects URL to use when being connected to this network next time</li> 
+</ol>
+</dd>
+</dl>
+
+
+
+
+<h2>More Screenshots</h2>
+
+<p>These are not really needed to explain how the program works.</p>
+
+<div><img class='screenshot' src='gfx/screenshot-menu.png' /></div>
+<div><img class='screenshot' src='gfx/screenshot-delete.png' /></div>
+<div><img class='screenshot' src='gfx/screenshot-launch-settings-empty.png' /></div>
+<div><img class='screenshot' src='gfx/screenshot-about.png' /></div>
+
+</body>
+</html>
\ No newline at end of file