index.rst 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. Welcome to Gluon
  2. ================
  3. Gluon is a modular framework for creating OpenWrt-based firmwares for wireless mesh nodes.
  4. Several Freifunk communities in Germany use Gluon as the foundation of their Freifunk firmwares.
  5. .. toctree::
  6. :caption: User Documentation
  7. :maxdepth: 2
  8. user/getting_started
  9. user/site
  10. user/x86
  11. user/faq
  12. .. toctree::
  13. :caption: Features
  14. :maxdepth: 2
  15. features/configmode
  16. features/autoupdater
  17. features/wlan-configuration
  18. features/private-wlan
  19. features/wired-mesh
  20. features/dns-cache
  21. features/monitoring
  22. features/authorized-keys
  23. features/roles
  24. .. toctree::
  25. :caption: Developer Documentation
  26. :maxdepth: 2
  27. dev/basics
  28. dev/feature-flags
  29. dev/hardware
  30. dev/upgrade
  31. dev/wan
  32. dev/mac_addresses
  33. .. toctree::
  34. :caption: gluon-web Reference
  35. :maxdepth: 1
  36. dev/web/controller
  37. dev/web/model
  38. dev/web/view
  39. dev/web/i18n
  40. dev/web/config-mode
  41. .. toctree::
  42. :caption: Packages
  43. :maxdepth: 1
  44. package/gluon-client-bridge
  45. package/gluon-config-mode-contact-info
  46. package/gluon-config-mode-geo-location
  47. package/gluon-ebtables-filter-multicast
  48. package/gluon-ebtables-filter-ra-dhcp
  49. package/gluon-ebtables-segment-mld
  50. package/gluon-ebtables-source-filter
  51. package/gluon-radv-filterd
  52. package/gluon-web-admin
  53. package/gluon-web-logging
  54. .. toctree::
  55. :caption: Releases
  56. :maxdepth: 1
  57. releases/v2017.1.5
  58. releases/v2017.1.4
  59. releases/v2017.1.3
  60. releases/v2017.1.2
  61. releases/v2017.1.1
  62. releases/v2017.1
  63. releases/v2016.2.7
  64. releases/v2016.2.6
  65. releases/v2016.2.5
  66. releases/v2016.2.4
  67. releases/v2016.2.3
  68. releases/v2016.2.2
  69. releases/v2016.2.1
  70. releases/v2016.2
  71. releases/v2016.1.6
  72. releases/v2016.1.5
  73. releases/v2016.1.4
  74. releases/v2016.1.3
  75. releases/v2016.1.2
  76. releases/v2016.1.1
  77. releases/v2016.1
  78. releases/v2015.1.2
  79. releases/v2015.1.1
  80. releases/v2015.1
  81. releases/v2014.4
  82. releases/v2014.3.1
  83. releases/v2014.3
  84. Supported Devices & Architectures
  85. ---------------------------------
  86. ar71xx-generic
  87. ^^^^^^^^^^^^^^
  88. * 8devices
  89. - Carambola 2
  90. * ALFA Network
  91. - AP121
  92. - AP121U
  93. - Hornet-UB
  94. - Tube2H
  95. - N2
  96. - N5
  97. * Allnet
  98. - ALL0315N
  99. * Buffalo
  100. - WZR-HP-AG300H / WZR-600DHP
  101. - WZR-HP-G300NH
  102. - WZR-HP-G300NH2
  103. - WZR-HP-G450H
  104. * D-Link
  105. - DIR-505 (A1, A2)
  106. - DIR-615 (C1)
  107. - DIR-825 (B1)
  108. * GL Innovations
  109. - GL-AR150
  110. - GL-iNet 6408A (v1)
  111. - GL-iNet 6416A (v1)
  112. * Linksys
  113. - WRT160NL
  114. * Netgear
  115. - WNDR3700 (v1, v2)
  116. - WNDR3800
  117. - WNDRMAC (v2)
  118. * Onion
  119. - Omega
  120. * OpenMesh
  121. - MR600 (v1, v2)
  122. - MR900 (v1, v2)
  123. - MR1750 (v1, v2) [#ath10k]_
  124. - OM2P (v1, v2)
  125. - OM2P-HS (v1, v2, v3)
  126. - OM2P-LC
  127. - OM5P
  128. - OM5P-AN
  129. - OM5P-AC (v1, v2) [#ath10k]_
  130. * TP-Link
  131. - Archer C5 (v1) [#ath10k]_
  132. - Archer C7 (v2) [#ath10k]_
  133. - CPE210 (v1.0, v1.1)
  134. - CPE220 (v1.1)
  135. - CPE510 (v1.0, v1.1)
  136. - CPE520 (v1.1)
  137. - RE450
  138. - TL-WDR3500 (v1)
  139. - TL-WDR3600 (v1)
  140. - TL-WDR4300 (v1)
  141. - TL-WR710N (v1, v2.1)
  142. - TL-WR842N/ND (v1, v2, v3)
  143. - TL-WR1043N/ND (v1, v2, v3, v4)
  144. - TL-WR2543N/ND (v1)
  145. - WBS210 (v1.20)
  146. - WBS510 (v1.20)
  147. * Ubiquiti
  148. - Air Gateway
  149. - Air Gateway LR
  150. - Air Gateway PRO
  151. - Air Router
  152. - Bullet M2/M5
  153. - Loco M2/M5
  154. - Loco M2/M5 XW
  155. - Nanostation M2/M5
  156. - Nanostation M2/M5 XW
  157. - Picostation M2/M5
  158. - Rocket M2/M5
  159. - Rocket M2/M5 Ti
  160. - Rocket M2/M5 XW
  161. - UniFi AP
  162. - UniFi AP AC Lite [#ath10k]_
  163. - UniFi AP AC Pro [#ath10k]_
  164. - UniFi AP LR
  165. - UniFi AP Pro
  166. - UniFi AP Outdoor
  167. - UniFi AP Outdoor+
  168. * Western Digital
  169. - My Net N600
  170. - My Net N750
  171. .. [#ath10k]
  172. Device uses the ath10k WLAN driver; images are built for 11s by default unless GLUON_WLAN_MESH
  173. is set as described in :ref:`getting-started-make-variables`
  174. ar71xx-nand
  175. ^^^^^^^^^^^
  176. * Netgear
  177. - WNDR3700 (v4)
  178. - WNDR4300 (v1)
  179. ar71xx-tiny
  180. ^^^^^^^^^^^
  181. * D-Link
  182. - DIR-615 (C1)
  183. * TP-Link
  184. - TL-MR13U (v1)
  185. - TL-MR3020 (v1)
  186. - TL-MR3040 (v1, v2)
  187. - TL-MR3220 (v1, v2)
  188. - TL-MR3420 (v1, v2)
  189. - TL-WA701N/ND (v1, v2)
  190. - TL-WA730RE (v1)
  191. - TL-WA750RE (v1)
  192. - TL-WA801N/ND (v1, v2, v3)
  193. - TL-WA830RE (v1, v2)
  194. - TL-WA850RE (v1)
  195. - TL-WA860RE (v1)
  196. - TL-WA901N/ND (v1, v2, v3, v4)
  197. - TL-WA7210N (v2)
  198. - TL-WA7510N (v1)
  199. - TL-WR703N (v1)
  200. - TL-WR710N (v1, v2, v2.1)
  201. - TL-WR740N (v1, v3, v4, v5)
  202. - TL-WR741N/ND (v1, v2, v4, v5)
  203. - TL-WR743N/ND (v1, v2)
  204. - TL-WR841N/ND (v3, v5, v7, v8, v9, v10, v11, v12)
  205. - TL-WR843N/ND (v1)
  206. - TL-WR940N (v1, v2, v3, v4)
  207. - TL-WR941ND (v2, v3, v4, v5, v6)
  208. brcm2708-bcm2708
  209. ^^^^^^^^^^^^^^^^
  210. * RaspberryPi 1
  211. brcm2708-bcm2709
  212. ^^^^^^^^^^^^^^^^
  213. * RaspberryPi 2
  214. mpc85xx-generic
  215. ^^^^^^^^^^^^^^^
  216. * TP-Link
  217. - TL-WDR4900 (v1)
  218. x86-generic
  219. ^^^^^^^^^^^
  220. * x86-generic
  221. * x86-virtualbox
  222. * x86-vmware
  223. See also: :doc:`user/x86`
  224. x86-geode
  225. ^^^^^^^^^
  226. * x86-geode
  227. See also: :doc:`user/x86`
  228. x86-64
  229. ^^^^^^
  230. * x86-64-generic
  231. * x86-64-virtualbox
  232. * x86-64-vmware
  233. See also: :doc:`user/x86`
  234. License
  235. -------
  236. See LICENCE_
  237. .. _LICENCE: https://github.com/freifunk-gluon/gluon/blob/master/LICENSE
  238. Indices and tables
  239. ==================
  240. * :ref:`genindex`
  241. * :ref:`search`