diff --git a/Readme.md b/Readme.md index 1cb0814..dc084bb 100644 --- a/Readme.md +++ b/Readme.md @@ -1,12 +1,18 @@ -# gluon site examples +# gluon site-example This is a commented version of Lübecks `site.conf` and `site.mk` (without **gluon-legacy** package and configuration). -Other site.conf Repositories: +Feel free to open issues if something has changed or still is undocumented: -* [Hamburg](https://github.com/freifunkhamburg/site-ffhh) -* [Lübeck](https://github.com/freifunk-gluon/site-ffhl) -* [Magdeburg](https://github.com/FreifunkMD/site-ffmd) -* [Mainz](https://github.com/Freifunk-Mainz/site-ffmz) -* Oldenburg: [gitphp](http://git.freifunk-ol.de/projects/ffol/gluon-siteconf.git) / [redmine](https://ticket.freifunk-ol.de/projects/siteconf-ffol/repository) -* [Paderborn](https://git.c3pb.de/freifunk-pb/site-ffpb) +* [site-example GitHub Issues](https://github.com/freifunk-gluon/site-example/issues) + +Pull requests solving the issues are welcome. + +## site-ff* + +* [site-ffhh](https://github.com/freifunkhamburg/site-ffhh) (Hamburg) +* [site-ffhl](https://github.com/freifunk-gluon/site-ffhl) (Lübeck) +* [site-ffmd](https://github.com/FreifunkMD/site-ffmd) (Magdeburg) +* [site-ffmz](https://github.com/Freifunk-Mainz/site-ffmz) (Mainz) +* [siteconf-ffol](https://ticket.freifunk-ol.de/projects/siteconf-ffol/repository) (Oldenburg) +* [site-ffpb](https://git.c3pb.de/freifunk-pb/site-ffpb) (Paderborn) diff --git a/site.conf b/site.conf index 86524f2..241eda0 100644 --- a/site.conf +++ b/site.conf @@ -48,11 +48,15 @@ sub: ssid: Wifi name shown to the user channel: Wifi channel to use - htmode: - mesh_ssid: SSID of the mesh-interface, an ugly SSID prevent clients from connecting + htmode: Specifies the channel width in 802.11n and 802.11ac mode, possible values are: + HT20 (single 20MHz channel), + HT40- (2x 20MHz channels, primary/control channel is upper, secondary channel is below) + HT40+ (2x 20MHz channels, primary/control channel is lower, secondary channel is above). + VHT20 / VHT40 / VHT80 / VHT160 (channel width in 802.11ac, extra channels are picked according to the specification) + http://wiki.openwrt.org/doc/uci/wireless#common.options (-> htmode) + mesh_ssid: SSID of the mesh-interface, an ugly SSID prevent clients from connecting (We recommend %site_code%.freifunk.net) mesh_bssid: BSSID of the mesh-interface mesh_mcast_rate: multicast rate of the mesh-interface - (TODO: fill me) ]] regdom = 'DE', @@ -81,21 +85,22 @@ ip4: IPv4 Address to use ip6: IPv6 Address to use mac: MAC Address to use - (TODO: Why is there a mac?) + (TODO: What is the purpose of this MAC-Adress here?) ]] next_node = { ip4 = '10.130.0.1', ip6 = 'fdef:ffc0:3dd7::1', - -- TODO why is there a mac ? mac = '16:41:95:40:f7:dc', }, --[[ Gateway settings fastd_mesh_vpn: fastd vpn settings + https://projects.universe-factory.net/projects/fastd/wiki/User_manual sub methods: encryption algorithms to use - (TODO: What happens if you use multiple? Is this possible?) + https://projects.universe-factory.net/projects/fastd/wiki/Methods + When multiple method statements are given, the first one has the highest preference. mtu: package size backbone: fastd vpn gateways of your community sub @@ -169,9 +174,7 @@ experimental = { -- DE: Name des "braches" wird beim erstellen von Images / update generiert name = 'experimental', - -- DE: Update Server. Diest ist ein einfacher Webserver ohne spezielle Konfiguration mirrors = {'http://1.updates.services.ffhl/experimental/sysupgrade'}, - -- TODO was ist das ? probability = 1.00, good_signatures = 2, good_signatures = 1, @@ -184,7 +187,7 @@ }, - --[[ Simple TC settings to limit the vpn-uplink + --[[ Simple TC settings to limit the bandwidth of the vpn-uplink mesh_vpn: sub ifname: name of the interface/bridge @@ -203,12 +206,12 @@ --[[ Config Mode settings - Text shown on local website on node. you can use html here. - msg_welcome: Welcome message shown at first startup + Text shown on local website on node while in config mode (after initial flashing or after a long press and hold on the primary button and reboot). You can use html here. + msg_welcome: Welcome message shown at startup msg_pubkey: Instructions for the user how your community handles the key exchange only shown if VPN setting is selected msg_reboot: Message shown when configuration is finished while the node is rebooting. - + Variables Within the text given here you can use variables which are replaced when the respective website is delivered to the user. diff --git a/site.mk b/site.mk index a38f8b6..8555e9b 100644 --- a/site.mk +++ b/site.mk @@ -1,6 +1,6 @@ ## gluon site.mk makefile example -## GLUON_SITE_PACKAGES +## GLUON_SITE_PACKAGES # specify gluon/openwrt packages to include here GLUON_SITE_PACKAGES := \ @@ -21,7 +21,7 @@ GLUON_SITE_PACKAGES := \ haveged -## DEFAULT_GLUON_RELEASE +## DEFAULT_GLUON_RELEASE # version string to use for images # gluon relies on # opkg compare-versions "$1" '>>' "$2" @@ -29,5 +29,13 @@ GLUON_SITE_PACKAGES := \ DEFAULT_GLUON_RELEASE := 0.4+0-exp$(shell date '+%Y%m%d') + +## GLUON_RELEASE +# call make with custom GLUON_RELEASE flag, to use your own release version scheme. +# e.g.: +# $ make images GLUON_RELEASE=23.42+5 +# would generate images named like this: +# gluon-ff%site_code%-23.42+5-%router_model%.bin + # Allow overriding the release number from the command line GLUON_RELEASE ?= $(DEFAULT_GLUON_RELEASE)