index.rst 4.8 KB

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