Changes between Version 2 and Version 3 of FAQ

Show
Ignore:
Timestamp:
01/21/06 16:47:23 (13 years ago)
Author:
benoitg
Comment:

Partially reformat the FAQ

Legend:

Unmodified
Added
Removed
Modified
  • FAQ

    v2 v3  
     1[[PageOutline(1-3)]] 
    12= General FAQ = 
    2  
    33General questions about the Wifidog Captive Portal 
    44 
    5 Q: What is Wifidog ? 
     5== Q: What is Wifidog ? == 
    66  A: Wifidog is software used to create wireless hotspots. It is a next-generation alternative to [http://nocat.net/ NoCat]. 
    77 
    8 Q: Who makes Wifidog ? 
     8== Q: Who makes Wifidog ? == 
    99  A: The technical team of [http://www.ilesansfil.org Île Sans Fil] created and maintains Wifidog. 
    1010 
    11 Q: Who can use Wifidog ? 
     11== Q: Who can use Wifidog ? ==  
    1212  A: On the legal/licensing front, anyone can use Wifidog. It is free software released under the GPL license. 
    1313 
     
    1616  If the software ever reaches a point of complete point-and-click ease that we feel average users can safely administer, we will update this document. 
    1717 
    18 Q: Who currently uses Wifidog ? 
     18== Q: Who currently uses Wifidog ? == 
    1919  A: Please go to the [wiki:Community] page 
    2020 
    21 Q: What can it do ? 
     21== Q: What can it do ? == 
    2222  A: See the [wiki:Features] page for the feature list. 
    2323 
    24 Q: What is it composed of ? 
     24== Q: What is it composed of ? == 
    2525  A: It is composed of 2 components: 
    2626  1. The client is a daemon process - this gets installed on every wireless router 
    2727  2. The auth server is a web application - this gets installed in a central location  
    2828 
    29 Q: What are the main differences between it and !NoCat ? 
     29== Q: What are the main differences between it and !NoCat ? == 
    3030  A: On the client side, it's smaller, has far fewer dependencies, and runs well on embedded devices. 
    3131  On the auth server side, it's more customizable, and is geared towards capitalizing the infrastructure for the purposes of building portals and communities. 
    3232 
    33 Q: How does it work ? 
     33== Q: How does it work ? == 
    3434  A: The client daemon uses firewall rules to control traffic going through the router. When a new user tries to access a web site, the client will transparently re-direct them to the auth server where they can either log-in or sign-up. The client and the auth server then negotiate what to do with the client and either allow or deny them certain network access. 
    3535 
     
    3838  Refer to the Wifidog Flow Diagram document for some more details. 
    3939 
    40 Q: What does it run on ? 
     40== Q: What does it run on ? == 
    4141  A: The client runs on any Linux machine that has a working netfilter+iptables installation. The auth server runs on any PHP-enabled web server. 
    4242 
    43 Q: Can I write my own client ? 
     43== Q: Can I write my own client ? == 
    4444  A: Sure, but why ? We've done all the work. The client is written in C and is extremely lightweight so that it runs comfortably in embedded environments such as the Linksys WRT54G router. 
    4545 
    4646  The client is time-tested and is fairly stable. It is used extensively in Île Sans Fil's [http://auth.ilesansfil.org deployed hotspots]. 
    4747 
    48 Q: Can I write my own auth server ? 
     48== Q: Can I write my own auth server ? == 
    4949  A: Again, we've done all the work. However our auth server at the time of this writing is not as polished as the client. Feel free to make it better or write your own from scratch. If you go with the later option you'll have to respect the same protocol the client uses for the whole system to work correctly. 
    5050 
    51 Q: What does it look like ? 
     51== Q: What does it look like ? == 
    5252  A: The client is a daemon process that runs in the background. It looks like zen, chi, the ether, zilch. It has no user interface. 
    5353 
    5454  The auth server is a web application that can be customized via templates to look however you want it to look. To check out Île Sans Fil's auth server installation see https://auth.ilesansfil.org 
    5555 
    56 Q: Where can I find help ? 
     56== Q: Where can I find help ? == 
    5757  A: If you've read the documentation, browsed the FAQ, tested a configuration setup (try your best) and you're still experiencing issues with your setup. You can find help by posting your question to the Wifidog mailling listexternal link (make sure you search through the mailing list archiveexternal link before you do so). 
    5858 
     
    6666Questions about the Wifidog client (not embedded) 
    6767 
    68 Q: What do I need ? 
     68== Q: What do I need ? == 
    6969  A: 
    7070    1. Basic proficiency in a Linux environment 
     
    7474    5. The latest Wifidog tarball which can be obtained from [http://sourceforge.net/project/showfiles.php?group_id=102646 SourceForge] 
    7575 
    76 Q: Pre-installation 
     76== Q: Pre-installation == 
    7777  A: This is where a lot of people run into problems, so let's state this in bold: 
    7878 
     
    9292  Do NOT proceed with installing Wifidog until you've satisfied the above. It will not work otherwise and you will waste lots of time. 
    9393 
    94 Q: Installation 
     94== Q: Installation == 
    9595  A: Wifidog, like many open source projects, is distributed with standard autotools utilities to make installation easy. Unpack the tarball, then follow the standard: 
    9696 
     
    101101}}} 
    102102 
    103 Q: Configuration 
     103== Q: Configuration == 
    104104  A: Edit /etc/wifidog.conf and follow the instructions in the file. Things should be self-explanatory. 
    105105 
    106 Q: Running Wifidog for the first time 
     106== Q: Running Wifidog for the first time == 
    107107  A: Run Wifidog with the following switches: 
    108108 
     
    113113}}} 
    114114 
    115 Q: Testing 
     115== Q: Testing == 
    116116  A: As a client on the !WiFi network (or whatever interface is configured as the LAN interface in /etc/wifidog.conf), open a web browser and try to browse to your favourite web site. 
    117117 
     
    122122Due to the lightness of the Wifidog client it is often installed inside the linksys WRT54G. There are some profound issues that arise with this setup that it warrants its own section in this FAQ. 
    123123 
    124 Q: What do I need ? 
     124== Q: What do I need ? == 
    125125  A: You will need to have basic/full proficiency in a Linux environment 
    126126 
     
    129129  Do not proceed until you've completed the above. We also recommend you spend some time familiarizing yourself with your new router's OS before introducing Wifidog into that environment. This especially includes the nvram settings, network interfaces and existing interface bridges. 
    130130 
    131 Q: Pre-installation 
     131== Q: Pre-installation == 
    132132  A: The same rules apply as the pre-installation in a non-WRT54G environment above. Do not proceed until you've satisfied them.  
    133133  In summary: '''Make sure EVERYTHING works first'''. 
     
    137137Questions about the Wifidog Auth-Server 
    138138 
    139 Q: What are the requirements to run the Auth Server ? 
     139== Q: What are the requirements to run the Auth Server ? == 
    140140  A: 
    141141 
     
    150150  * [http://drewish.com/projects/phlickr/ Phlick API] for Flickr content ( Content management system )  
    151151 
    152 Q: Can I use MySQL in lieu of PostgreSQL ? 
     152== Q: Can I use MySQL in lieu of PostgreSQL ? == 
    153153  A: No, but we are looking for a developper committed to maintain the SQL code and port it to MySQL. Since MySQL is less feature rich than PostgreSQL we might have some trouble implementing some advanced stats / BLOB queries ... 
    154154 
    155 Q: The CMS is too complex, I simply want to put some HTML code on the portal page ! 
     155== Q: The CMS is too complex, I simply want to put some HTML code on the portal page ! == 
    156156  A: We are aware that we will need to provide a better documentation. Although, the answer to this specific question is quite easy. You would simply need to use a "TrivialLangstring" content and drop some HTML code in the textfield and ties this content to the portal page. 
    157157 
    158 Q: Can I extract the hotspot status data in XML format ? 
     158== Q: Can I extract the hotspot status data in XML format ? == 
    159159  A: Yes, the hotspots status list can be exported to a XML. In fact, the Google Maps mashup part of Wifidog relies on this feature. [http://ilesansfil.org/tiki-index.php?page=HotSpots Île Sans Fil is also using it] to create a specially formatted display on its main website using [http://auth.ilesansfil.org/xslt/wifidog_status.xsl an XSL stylesheet]. 
    160160 
    161 Q: My auth server used to be fast, but now it's slower and slower, even under no load 
     161== Q: My auth server used to be fast, but now it's slower and slower, even under no load == 
    162162 
    163163  A: You have to: