----

== Developer Guide ==

WISP in a Box development is organized as an Open-Source or [http://en.wikipedia.org/wiki/Free_software Libré] software project.

In order to understand what this means and be able to work together in this way we need to agree on the definitions of the following five words:

* '''Upstream''' - We use the term ''Upstream'' to refer to projects which our project makes use of. For example [http://net-snmp.sourceforge.net/ net-snmp] and [http://code.google.com/p/afrimesh afrimesh] are both ''upstream'' projects of the WispBox.

* '''Downstream''' - ''Downstream'' are projects who use our code. For example, if someone were to create a linux distribution which focused on adding VOIP services to a WISP and which used [http://code.google.com/p/wispinabox WispBox] as a dependency then that project would be considered to be ''downstream'' from our project.

[[Image:libre_software_cycle.png|right|frame|The Libré Software Development Cycle]]

* '''Users''' - We live and breathe for these special individuals as, without them, none of us would have paying jobs. Their interaction with the project is usually in the form of downloading and using our software, reporting bugs on the mailing list or bug tracker and asking for more features.

* '''Contributors''' - ''Contributors'' are usually also users but they have both the ability and the desire to contribute code patches, documentation and generally contribute their expertise to project development discussions. Often, future developers on a project are drawn from the pool of contributers. Contributors are a necessary condition to the long-term sustainability of Libré projects. For this reason all new developers are first required to spend some time as a contributor to the project before they are "handed the keys to the house" and gain full access to the project infrastructure.

* '''Developers''' - ''Developers'' perform the bulk of the development work and have full access to the project source repositories, servers and other infrastructure.

=== Upstream Projects ===

WISP in a Box has many upstream dependencies. The following list are the ones you will see referred to most commonly:

* [http://code.google.com/p/afrimesh '''Afrimesh'''] - the WispBox component integration toolkit and the core management dashboard.
* [http://uck.sourceforge.net/ '''Ubuntu Customization Kit'''] - A set of scripts used by our build system to generate the WispBox livecd images.

=== Setup Checklist ===

{| cellpadding="5" cellspacing="0" border="1"
! Task !! Description
|- valign="top"
| Development Workstation ||
* x86
* FreeBSD or Ubuntu
* 1x ??? USB WiFi network card
|- valign="top"
| WISP Server ||
* AMD ION
* 1GB RAM
* 80GB Hard Drive
* D-Link USB Ethernet
|- valign="top"
| Development Mesh Node ||
* D-Link DIR-300
|- valign="top"
| Deployment Mesh Node ||
* HPN
|- valign="top"
| Subscribe to mailing lists || TODO
|- valign="top"
| Join IRC || Install an IRC client and configure it for irc.freenode.net, #afrimesh (ask George if you need help)
|- valign="top"
| Configure WispBox Development Environment ||
Read: http://code.google.com/p/wispinabox/wiki/DevelopmentEnvironment
|- valign="top"
| Configure Afrimesh Development Environment ||
Read: http://code.google.com/p/afrimesh/wiki/DevelopmentEnvironment
|-
|}

=== Core Project Infrastructure ===

{| cellpadding="5" cellspacing="0" border="1"
! Resource !! URL !! Description
|-
| Mailing List - User Support || TO COME || Users, Contributors and Developers should subscribe to and follow this list.
|-
| Mailing List - Development || TO COME || Contributors and Developers should subscribe to and follow this list.
|-
| Issue tracker || http://code.google.com/p/wispinabox/issues/list || Bug reports and feature requests submitted to the Issue tracker are more likely to receive attention!
|-
| IRC || http://webchat.freenode.net/?channels=afrimesh || For IRC client configuration, use: irc.freenode.net, #afrimesh
|-
| Wiki - Main || http://wirelessafrica.meraka.org.za/wiki/index.php?title=WISP_in_a_Box_Development ||
|-
| Wiki - WispBox || http://code.google.com/p/wispinabox/w || Content hosted here still needs to be migrated to the main wiki
|-
| Wiki - Afrimesh || http://code.google.com/p/afrimesh/w || Afrimesh services multiple projects and as such maintains a separate wiki
|-
| Version Control - WispBox || http://code.google.com/p/wispinabox/source/checkout ||
|-
| Version Control - Afrimesh || http://code.google.com/p/afrimesh/source/checkout ||
|-
| Package Repository || https://launchpad.net/~wispinabox ||
|-
| Build Server || TO COME ||
|-
|}

=== Resources ===

* [[Media:Community_barriers_to_entry_checklist.pdf|'''Barriers to entry for community participation''']] - Neary Consulting

----

2009-08-04T13:11:49Z

Antoine: uploaded a new version of "Image:Libre software cycle.png"

WISP in a Box Development

2009-08-04T13:09:42Z

Antoine:

----

== Developer Guide ==

WISP in a Box development is organized as an Open-Source or [http://en.wikipedia.org/wiki/Free_software Libré] software project.

In order to understand what this means and be able to work together in this way we need to agree on the definitions of the following five words:

* '''Upstream''' - We use the term ''Upstream'' to refer to projects which our project makes use of. For example [http://net-snmp.sourceforge.net/ net-snmp] and [http://code.google.com/p/afrimesh afrimesh] are both ''upstream'' projects of the WispBox.

* '''Downstream''' - ''Downstream'' are projects who use our code. For example, if someone were to create a linux distribution which focused on adding VOIP services to a WISP and which used [http://code.google.com/p/wispinabox WispBox] as a dependency then that project would be considered to be ''downstream'' from our project.

[[Image:libre_software_cycle.png|right|frame|The Libré Software Development Cycle]]

* '''Users''' - We live and breathe for these special individuals as, without them, none of us would have paying jobs. Their interaction with the project is usually in the form of downloading and using our software, reporting bugs on the mailing list or bug tracker and asking for more features.

* '''Contributors''' - ''Contributors'' are usually also users but they have both the ability and the desire to contribute code patches, documentation and generally contribute their expertise to project development discussions. Often, future developers on a project are drawn from the pool of contributers. Contributors are a necessary condition to the long-term sustainability of Libré projects. For this reason all new developers are first required to spend some time as a contributor to the project before they are "handed the keys to the house" and gain full access to the project infrastructure.

* '''Developers''' - ''Developers'' perform the bulk of the development work and have full access to the project source repositories, servers and other infrastructure.

=== Upstream Projects ===

WISP in a Box has many upstream dependencies. The following list are the ones you will see referred to most commonly:

* [http://code.google.com/p/afrimesh '''Afrimesh'''] - the WispBox component integration toolkit and the core management dashboard.
* [http://uck.sourceforge.net/ '''Ubuntu Customization Kit''' - A set of scripts used by our build system to generate the WispBox livecd images.

=== Core Project Infrastructure ===

Project Communication

{| cellpadding="5" cellspacing="0" border="1"
! Resource !! URL !! Description
|-
| Mailing List - User Support || TO COME || Users, Contributors and Developers should subscribe to and follow this list.
|-
| Mailing List - Development || TO COME || Contributors and Developers should subscribe to and follow this list.
|-
| Issue tracker || http://code.google.com/p/wispinabox/issues/list || Bug reports and feature requests submitted to the Issue tracker are more likely to receive attention!
|-
| IRC || http://webchat.freenode.net/?channels=afrimesh || For IRC client configuration, use: irc.freenode.net, #afrimesh
|-
| Wiki - Main || http://wirelessafrica.meraka.org.za/wiki/index.php?title=WISP_in_a_Box_Development ||
|-
| Wiki - WispBox || http://code.google.com/p/wispinabox/w || Content hosted here still needs to be migrated to the main wiki
|-
| Wiki - Afrimesh || http://code.google.com/p/afrimesh/w || Afrimesh services multiple projects and as such maintains a separate wiki
|-
| Sources - WispBox || http://code.google.com/p/wispinabox/source/checkout ||
|-
| Sources - Afrimesh || http://code.google.com/p/afrimesh/source/checkout ||
|-
| Package Repository || https://launchpad.net/~wispinabox ||
|-
| Build Server || TO COME ||
|-
|}

=== Setting up your development environment ===

----

WISP in a Box Development

2009-08-04T13:06:25Z

2009-08-04T12:21:11Z

Antoine: /* Developer Guide */

== Developer Guide ==

WISP in a Box development is organized as an Open-Source or [http://en.wikipedia.org/wiki/Free_software Libré] software project.

[[Image:libre_software_cycle.png|left|frame|The Libré Software Development Cycle]]

In order to understand what this means and be able to work together in this way we need to agree on the definitions of the following five words:

* '''Upstream''' - We use the term ''Upstream'' to refer to projects which our project makes use of. For example [http://net-snmp.sourceforge.net/ net-snmp] and [http://code.google.com/p/afrimesh afrimesh] are both ''upstream'' projects of the WispBox.

* '''Downstream''' - ''Downstream'' are projects who use our code. For example, if someone were to create a linux distribution which focused on adding VOIP services to a WISP and which used [http://code.google.com/p/wispinabox WispBox] as a dependency then that project would be considered to be ''downstream'' of our project.

* '''Users''' - We live and breathe for these special individuals as, without them, none of us would have paying jobs. Their interaction with the project is usually in the form of downloading and using our software, reporting bugs on the mailing list or bug tracker and asking for more features.

* '''Contributors''' - ''Contributors'' are usually also users but they have both the ability and the desire to contribute code patches, documentation and generally contribute their expertise to project development discussions. Often, future developers on a project are drawn from the pool of contributers. Contributors are a necessary condition to the long-term sustainability of Libré projects. For this reason all new developers are first required to spend some time as a contributor to the project before they are "handed the keys to the house" and gain full access to the project infrastructure.

* '''Developers''' - ''Developers'' perform the bulk of the development work and have full access to the project source repositories, servers and other infrastructure.

=== Project Infrastructure ===

WISP in a Box Development

2009-08-04T12:19:38Z

Antoine:

== Developer Guide ==

WISP in a Box development is organized as an Open-Source or [http://en.wikipedia.org/wiki/Free_software Libré] software project.

In order to understand what this means and be able to work together in this way we need to agree on the definitions of the following five words:

* '''Upstream''' - We use the term ''Upstream'' to refer to projects which our project makes use of. For example [http://net-snmp.sourceforge.net/ net-snmp] and [http://code.google.com/p/afrimesh afrimesh] are both ''upstream'' projects of the WispBox.

* '''Downstream''' - ''Downstream'' are projects who use our code. For example, if someone were to create a linux distribution which focused on adding VOIP services to a WISP and which used [http://code.google.com/p/wispinabox WispBox] as a dependency then that project would be considered to be ''downstream'' of our project.

* '''Users''' - We live and breathe for these special individuals as, without them, none of us would have paying jobs. Their interaction with the project is usually in the form of downloading and using our software, reporting bugs on the mailing list or bug tracker and asking for more features.

* '''Contributors''' - ''Contributors'' are usually also users but they have both the ability and the desire to contribute code patches, documentation and generally contribute their expertise to project development discussions. Often, future developers on a project are drawn from the pool of contributers. Contributors are a necessary condition to the long-term sustainability of Libré projects. For this reason all new developers are first required to spend some time as a contributor to the project before they are "handed the keys to the house" and gain full access to the project infrastructure.

* '''Developers''' - ''Developers'' perform the bulk of the development work and have full access to the project source repositories, servers and other infrastructure.

[[Image:libre_software_cycle.png|left|frame|The Libré Software Development Cycle]]

WISP in a Box Development

2009-08-04T12:18:56Z

Antoine:

== Developer Guide ==

WISP in a Box development is organized as an Open-Source or [http://en.wikipedia.org/wiki/Free_software Libré] software project.

In order to understand what this means and be able to work together in this way we need to agree on the definitions of the following five words:

* '''Upstream''' - We use the term ''Upstream'' to refer to projects which our project makes use of. For example [http://net-snmp.sourceforge.net/ net-snmp] and [http://code.google.com/p/afrimesh afrimesh] are both ''upstream'' projects of the WispBox.
* '''Downstream''' - ''Downstream'' are projects who use our code. For example, if someone were to create a linux distribution which focused on adding VOIP services to a WISP and which used [http://code.google.com/p/wispinabox WispBox] as a dependency then that project would be considered to be ''downstream'' of our project.
* ''Users''' - We live and breathe for these special individuals as, without them, none of us would have paying jobs. Their interaction with the project is usually in the form of downloading and using our software, reporting bugs on the mailing list or bug tracker and asking for more features.
* ''Contributors'' - Contributors are usually also users but they have both the ability and the desire to contribute code patches, documentation and generally contribute their expertise to project development discussions. Often, future developers on a project are drawn from the pool of contributers. Contributors are a necessary condition to the long-term sustainability of Libré projects. For this reason all new developers are first required to spend some time as a contributor to the project before they are "handed the keys to the house" and gain full access to the project infrastructure.
* ''Developers'' - Developers perform the bulk of the development work and have full access to the project source repositories, servers and other infrastructure.

[[Image:libre_software_cycle.png|left|frame|The Libré Software Development Cycle]]

WISP in a Box Development

2009-08-04T12:08:24Z

Antoine:

2009-08-04T11:44:18Z

Antoine: /* Developer Guide */

== Developer Guide ==

[[Image:libre_software_cycle.png]|foo]

File:Libre software cycle.png

2009-08-04T11:43:28Z

Antoine:

WISP in a Box Development

2009-08-04T11:43:04Z

Antoine: New page: == Developer Guide == foo

== Developer Guide ==

[[Image:libre_software_cycle.png|foo]]

AfrimeshToDo

2009-07-05T16:30:39Z

Antoine:

[[Category: WISP in a box]]

== Dashboard ==
* Customers
** Recharge -> Solicit feedback
** Manage -> How to make MAC/IP auth obvious from interface ?
** Manage -> Implement seconds left field
** Manage -> Fix New/Modify/Delete/Password DONE
** Manage -> Paginate when > 'x' users
** Prices -> Implement DONE
*** Add or delete a plan
*** Set price & seconds DONE
* Network
** Map -> Refactor DONE
** Map -> Populate popups DONE
** Map -> Cache map data CODESPRINT
** Map -> Satellite overlay ?
** Health -> Health monitors
** Health -> Mesh congestion
** Health -> Messages
** Health -> Use case -> Spot misbehaving doze boxes
** Health -> Manage cap
** Health -> Query router settings, firmware versions?
** Activity -> Show seconds left
** Activity -> Show router name/address
** Activity -> Traffic info
* Settings
** Link to webmin
** Mesh -> Provisioning
*** use cases for: flashing firmware, installing packages, changing settings ?
** Mesh -> Set throttling on coova's
** Mesh -> Bandwidth/QOS
*** Manage cap
*** So start off with small allocation
*** Track use
*** Speak to David Johnson
*** Release buffer into the system
** Internet -> Webmin
** Internet -> Drop assumption that we control the gateway and rethink DONE
** Internet -> Bandwidth/QOS
** Internet -> Configure DONE
* Install
** On first run, default to settings pages
** Map -> Configure map: location, size, source (remote/local) CODESPRINT

== Routers ==
* Authentication
** coova -> finish packaging config
** a2billing -> write bridge DONE
* Mini Dash
** coova -> Make splash pretty
** coova -> Fix time left fields
** Diagnostics on splash!
** Signals strength indicator
* Install
** On first run, default to settings page
** Zoomed to max extent

== Deployment ==
* Start doing daily builds
* Dashboard Installation
** Ubuntu packages DONE
** ISO
** Download/Generate map data CODESPRINT
** phpMyPrepaid package
* Router Installation
** OpenWRT Packages -> broadcom, atheros DONE
*** Firewall configs
*** Auto-configuration
** Pre-installed firmware image
* Documentation
** Dashboard installation
** Router installation
** Instructions for using with other firmwares

== Security ==
* Implement auth

== Logging ==
* Set up some guidelines

== Dev Docs ==
* Document LQ colour coding

== Map Biz Process ==
* For docs

== Reporting Interface ==
* Expose the program tree to plugin / report authors DONE
* Read only
** What are my router channels ?
** etc.

AfrimeshToDo

2009-07-05T16:29:54Z

Antoine:

[[Category: WISP in a box]]

== Dashboard ==
* Customers
** Recharge -> Solicit feedback
** Manage -> How to make MAC/IP auth obvious from interface ?
** Manage -> Implement seconds left field
** Manage -> Fix New/Modify/Delete/Password DONE
** Manage -> Paginate when > 'x' users
** Prices -> Implement DONE
*** Add or delete a plan
*** Set price & seconds DONE
* Network
** Map -> Refactor DONE
** Map -> Populate popups DONE
** Map -> Cache map data CODESPRINT
** Map -> Satellite overlay ?
** Health -> Health monitors
** Health -> Mesh congestion
** Health -> Messages
** Health -> Use case -> Spot misbehaving doze boxes
** Health -> Manage cap
** Health -> Query router settings, firmware versions?
** Activity -> Show seconds left
** Activity -> Show router name/address
** Activity -> Traffic info
* Settings
** Link to webmin
** Mesh -> Provisioning
*** use cases for: flashing firmware, installing packages, changing settings ?
** Mesh -> Set throttling on coova's
** Mesh -> Bandwidth/QOS
*** Manage cap
*** So start off with small allocation
*** Track use
*** Speak to David Johnson
*** Release buffer into the system
** Internet -> Webmin
** Internet -> Drop assumption that we control the gateway and rethink DONE
** Internet -> Bandwidth/QOS
** Internet -> Configure DONE
* Install
** On first run, default to settings pages
** Map -> Configure map: location, size, source (remote/local) CODESPRINT

== Routers ==
* Authentication
** coova -> finish packaging config
** a2billing -> write bridge
* Mini Dash
** coova -> Make splash pretty
** coova -> Fix time left fields
** Diagnostics on splash!
** Signals strength indicator
* Install
** On first run, default to settings page
** Zoomed to max extent

== Deployment ==
* Start doing daily builds
* Dashboard Installation
** Ubuntu packages DONE
** ISO
** Download/Generate map data CODESPRINT
** phpMyPrepaid package
* Router Installation
** OpenWRT Packages -> broadcom, atheros DONE
*** Firewall configs
*** Auto-configuration
** Pre-installed firmware image
* Documentation
** Dashboard installation
** Router installation
** Instructions for using with other firmwares

== Security ==
* Implement auth

== Logging ==
* Set up some guidelines

== Dev Docs ==
* Document LQ colour coding

== Map Biz Process ==
* For docs

== Reporting Interface ==
* Expose the program tree to plugin / report authors DONE
* Read only
** What are my router channels ?
** etc.

User:Antoine

2009-07-05T13:20:42Z

Antoine:

'''Name:''' Antoine van Gelder

'''Email:''' antoine [at] 7degrees.co.za

'''Afrimesh:''' [http://code.google.com/p/afrimesh/ http://code.google.com/p/afrimesh/]

'''WispBox:''' [http://code.google.com/p/wispinabox/ http://code.google.com/p/wispinabox/]