index.rst 5.1 KB

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