README

== Overview ==
This is an application for web2py and is used to build preconfigured firmware
images for openwrt and LEDE and is a rewrite of the "Freifunk OpenWrt Imagebuilder" [1].

Meshkit is mainly intended to be used for creating
firmware images for wireless communities like Freifunk that are
"ready-to-mesh" directly after they have been flashed on a router. But with
the "noconf" config option it is also possible to use it just to build
OpenWrt images with a custom package selection and uploaded files included.

== A few words about how image configuration works ==
Meshkit itself just writes a uci config file and stores it in
/etc/config/meshkwizard in the resulting firmware image. The actual
configuration is done by meshwizard [2], which uses community profiles [3]
and the settings from meshkit to configure the device at first boot after
the device has been flashed.

== INSTALLATION ==
See the INSTALL file for installing and configuring meshkit.

== DEVELOPMENT ==
Watch Meshkit development at: https://github.com/freifunk/meshkit

== CONFIG ==
Different Communities can have different configs. this can be edited via
https://github.com/openwrt/luci/tree/master/contrib/package/community-profiles/files/etc/config
and special files here
https://github.com/freifunk/meshkit-community_files

== BUGTRACKER ==
Report bugs, feature requests etc. at: https://github.com/freifunk/meshkit/issues

== EXAMPLES ==
running meshkit servers are
*  Meshkit Freifunk general (openwrt cc) https://meshkit.freifunk.net/ and https://testing.meshkit.freifunk.net/
*  Meshkit Freifunk Halle (viele profiles, zb x86-kvm) https://meshkit.freifunk-halle.org/
*  Meshkit Freifunk Weimarnetz (nur für weimar-IPs) https://meshkit.weimarnetz.de/
*  Meshkit Freifunk Leipzig (viele profiles, auch x86, LEDE trunk-versionen) http://gadow.freifunk.net:8086/meshkit/

== DOCUMENTATION ==
https://github.com/freifunk/meshkit-doc

== LINKS ==
[1] http://trac.augsburg.freifunk.net/browser/kamikaze/contrib/imagebuilder
[2] http://luci.subsignal.org/trac/browser/luci/trunk/contrib/package/meshwizard
[3] http://luci.subsignal.org/trac/browser/luci/trunk/contrib/package/community-profiles