gluon-firmware/docs/index.rst

Welcome to Gluon
================

Gluon is a modular framework for creating OpenWrt-based firmwares for wireless mesh nodes.
Several Freifunk communities in Germany use Gluon as the foundation of their Freifunk firmwares.


User Documentation
------------------

.. toctree::
   :maxdepth: 2

   user/getting_started
   user/site
   user/x86
   user/faq

Features
--------

.. toctree::
   :maxdepth: 2

   features/configmode
   features/autoupdater
   features/wlan-configuration
   features/private-wlan
   features/wired-mesh
   features/monitoring
   features/authorized-keys
   features/roles

Developer Documentation
-----------------------

.. toctree::
   :maxdepth: 2

   dev/basics
   dev/hardware
   dev/upgrade
   dev/configmode
   dev/wan
   dev/i18n

Packages
--------

.. toctree::
   :maxdepth: 1

   package/gluon-client-bridge
   package/gluon-ebtables-filter-multicast
   package/gluon-ebtables-filter-ra-dhcp

Releases
--------

.. toctree::
   :maxdepth: 1

   releases/v2016.1
   releases/v2015.1.2
   releases/v2015.1.1
   releases/v2015.1
   releases/v2014.4
   releases/v2014.3.1
   releases/v2014.3


Supported Devices & Architectures
---------------------------------

ar71xx-generic
^^^^^^^^^^^^^^

* Allnet

  - ALL0315N

* Buffalo

  - WZR-HP-AG300H / WZR-600DHP
  - WZR-HP-G300NH
  - WZR-HP-G450H

* D-Link

  - DIR-505 (A1)
  - DIR-615 (C1)
  - DIR-825 (B1)

* GL-Inet

  - 6408A (v1)
  - 6416A (v1)

* Linksys

  - WRT160NL

* Netgear

  - WNDR3700 (v1, v2)
  - WNDR3800
  - WNDRMAC (v2)

* Onion

  - Omega

* TP-Link

  - CPE210 (v1.0, v1.1)
  - CPE220 (v1.0, v1.1)
  - CPE510 (v1.0, v1.1)
  - CPE520 (v1.0, v1.1)
  - TL-MR13U (v1)
  - TL-MR3020 (v1)
  - TL-MR3040 (v1, v2)
  - TL-MR3220 (v1, v2)
  - TL-MR3420 (v1, v2)
  - TL-WA701N/ND (v1, v2)
  - TL-WA750RE (v1)
  - TL-WA801N/ND (v1, v2)
  - TL-WA830RE (v1, v2)
  - TL-WA850RE (v1)
  - TL-WA860RE (v1)
  - TL-WA901N/ND (v1, v2, v3)
  - TL-WDR3500 (v1)
  - TL-WDR3600 (v1)
  - TL-WDR4300 (v1)
  - TL-WR703N (v1)
  - TL-WR710N (v1, v2)
  - TL-WR740N (v1, v3, v4, v5)
  - TL-WR741N/ND (v1, v2, v4, v5)
  - TL-WR743N/ND (v1, v2)
  - TL-WR801N/ND (v1, v2)
  - TL-WR841N/ND (v3, v5, v7, v8, v9, v10)
  - TL-WR842N/ND (v1, v2)
  - TL-WR843N/ND (v1)
  - TL-WR940N (v1, v2, v3)
  - TL-WR941ND (v2, v3, v4, v5, v6)
  - TL-WR1043N/ND (v1, v2, v3)
  - TL-WR2543N/ND (v1)

* Ubiquiti

  - Air Gateway
  - Air Router
  - Bullet M
  - Nanostation M
  - Nanostation M XW
  - Loco M XW
  - Picostation M
  - Rocket M
  - UniFi AP
  - UniFi AP Pro
  - UniFi AP Outdoor
  - UniFi AP Outdoor+

* Western Digital

  - My Net N600
  - My Net N750

ar71xx-nand
^^^^^^^^^^^

* Netgear

  - WNDR3700 (v4)
  - WNDR4300 (v1)

mpc85xx-generic
^^^^^^^^^^^^^^^

* TP-Link

  - TL-WDR4900 (v1)

x86-generic
^^^^^^^^^^^
* x86-generic
* x86-virtualbox
* x86-vmware

See also: :doc:`user/x86`

x86-kvm_guest
^^^^^^^^^^^^^
* x86-kvm

See also: :doc:`user/x86`

x86-xen_domu
^^^^^^^^^^^^
* x86-xen

See also: :doc:`user/x86`

x86-64
^^^^^^
* x86-64-generic
* x86-64-virtualbox
* x86-64-vmware

See also: :doc:`user/x86`

License
-------

See LICENCE_

.. _LICENCE: https://github.com/freifunk-gluon/gluon/blob/master/LICENSE

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
docs: initial sphinx project with very little content 2014-02-20 16:22:06 +00:00			`Welcome to Gluon`
			`================`

docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`Gluon is a modular framework for creating OpenWrt-based firmwares for wireless mesh nodes.`
			`Several Freifunk communities in Germany use Gluon as the foundation of their Freifunk firmwares.`
docs: initial sphinx project with very little content 2014-02-20 16:22:06 +00:00

			`User Documentation`
			`------------------`

			`.. toctree::`
			`:maxdepth: 2`

			`user/getting_started`
docs: more work on docs docs: Basic site documentation docs: Basic autoupdater documentation docs: minimal autoupdater info docs: bump version to 2014.2 Closes #114 2014-05-24 19:49:55 +00:00			`user/site`
docs: user/x86 Fixes #373 2015-05-16 13:02:47 +00:00			`user/x86`
docs: initial sphinx project with very little content 2014-02-20 16:22:06 +00:00			`user/faq`

			`Features`
			`--------`

			`.. toctree::`
			`:maxdepth: 2`

			`features/configmode`
			`features/autoupdater`
docs: add more documentation of WLAN configuration Fixes #574 2016-02-05 09:40:26 +00:00			`features/wlan-configuration`
docs: add private WLAN 2014-08-05 21:30:16 +00:00			`features/private-wlan`
docs: improve wired mesh documentation Fixes #376 2015-10-28 18:59:51 +00:00			`features/wired-mesh`
docs: update outdated monitoring documentation 2016-02-05 10:00:38 +00:00			`features/monitoring`
docs: authorized-keys 2014-09-15 17:26:30 +00:00			`features/authorized-keys`
add documentation for roles feature add by https://github.com/freifunk-gluon/packages/pull/83 2015-01-25 14:51:00 +00:00			`features/roles`
docs: initial sphinx project with very little content 2014-02-20 16:22:06 +00:00
			`Developer Documentation`
			`-----------------------`

			`.. toctree::`
			`:maxdepth: 2`

docs: move from README to docs/ 2014-07-09 10:43:10 +00:00			`dev/basics`
docs: add documentation about addings new hardware support 2014-09-09 15:08:46 +00:00			`dev/hardware`
Documentation and helper script for the new upgrade script handling 2015-01-23 02:29:37 +00:00			`dev/upgrade`
docs: document config-mode modules 2014-11-17 13:50:15 +00:00			`dev/configmode`
docs: add documentation for the WAN configuration 2015-01-27 03:27:27 +00:00			`dev/wan`
docs: add i18n howto 2015-04-25 17:22:15 +00:00			`dev/i18n`
docs: initial sphinx project with very little content 2014-02-20 16:22:06 +00:00
gluon-client-bridge: basic br-client config and wireless AP This package provides br-client and sets up a wireless AP interface for clients. 2015-08-17 22:53:40 +00:00			`Packages`
			`--------`

			`.. toctree::`
			`:maxdepth: 1`

			`package/gluon-client-bridge`
docs: add documentation for gluon-ebtables-filter-{multicast,ra-dhcp} 2015-11-22 23:39:32 +00:00			`package/gluon-ebtables-filter-multicast`
			`package/gluon-ebtables-filter-ra-dhcp`
gluon-client-bridge: basic br-client config and wireless AP This package provides br-client and sets up a wireless AP interface for clients. 2015-08-17 22:53:40 +00:00
docs: reorder index to make the release notes more prominent 2015-04-30 23:14:57 +00:00			`Releases`
			`--------`

			`.. toctree::`
			`:maxdepth: 1`

docs: rename development version to v2016.1 2016-01-01 15:29:15 +00:00			`releases/v2016.1`
docs: import v2015.1.2 release notes and list of supported devices 2015-08-09 12:56:03 +00:00			`releases/v2015.1.2`
docs: releases/v2015.1.1 2015-06-15 20:40:11 +00:00			`releases/v2015.1.1`
docs: reorder index to make the release notes more prominent 2015-04-30 23:14:57 +00:00			`releases/v2015.1`
			`releases/v2014.4`
			`releases/v2014.3.1`
			`releases/v2014.3`


update the table of supported hardware 2015-04-30 20:20:32 +00:00			`Supported Devices & Architectures`
			`---------------------------------`

			`ar71xx-generic`
			`^^^^^^^^^^^^^^`

			`* Allnet`
docs: fix hardware list formatting 2015-04-30 23:16:31 +00:00
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- ALL0315N`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00
docs: update supported devices, reorder them alphabetically and fix a model name 2014-12-17 19:22:59 +00:00			`* Buffalo`

			`- WZR-HP-AG300H / WZR-600DHP`
docs: add D-Link DIR-505 (A1) and Buffalo WZR-HP-G300NH (and remove WZR-HP-G300N, it is not actually supported) 2016-01-04 04:32:14 +00:00			`- WZR-HP-G300NH`
docs: update supported devices, reorder them alphabetically and fix a model name 2014-12-17 19:22:59 +00:00			`- WZR-HP-G450H`

			`* D-Link`

docs: add D-Link DIR-505 (A1) and Buffalo WZR-HP-G300NH (and remove WZR-HP-G300N, it is not actually supported) 2016-01-04 04:32:14 +00:00			`- DIR-505 (A1)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- DIR-615 (C1)`
docs: add D-Link DIR-505 (A1) and Buffalo WZR-HP-G300NH (and remove WZR-HP-G300N, it is not actually supported) 2016-01-04 04:32:14 +00:00			`- DIR-825 (B1)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00
			`* GL-Inet`
docs: fix hardware list formatting 2015-04-30 23:16:31 +00:00
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- 6408A (v1)`
docs: hardware support list fixes 2015-05-15 22:23:12 +00:00			`- 6416A (v1)`
docs: update supported devices, reorder them alphabetically and fix a model name 2014-12-17 19:22:59 +00:00
			`* Linksys`

			`- WRT160NL`

update the table of supported hardware 2015-04-30 20:20:32 +00:00			`* Netgear`
docs: fix hardware list formatting 2015-04-30 23:16:31 +00:00
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- WNDR3700 (v1, v2)`
			`- WNDR3800`
docs: add WNDRMACv2 to list of supported devices 2015-05-10 10:07:52 +00:00			`- WNDRMAC (v2)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00
docs: update list of supported hardware 2016-03-02 00:03:33 +00:00			`* Onion`

			`- Omega`

docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`* TP-Link`

docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`- CPE210 (v1.0, v1.1)`
			`- CPE220 (v1.0, v1.1)`
			`- CPE510 (v1.0, v1.1)`
			`- CPE520 (v1.0, v1.1)`
docs: update list of supported hardware 2016-03-02 00:03:33 +00:00			`- TL-MR13U (v1)`
docs: update list of supported devices 2014-12-16 11:39:09 +00:00			`- TL-MR3020 (v1)`
			`- TL-MR3040 (v1, v2)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- TL-MR3220 (v1, v2)`
docs: update list of supported devices 2014-12-16 11:39:09 +00:00			`- TL-MR3420 (v1, v2)`
docs: import v2015.1.2 release notes and list of supported devices 2015-08-09 12:56:03 +00:00			`- TL-WA701N/ND (v1, v2)`
docs: update list of supported devices 2014-12-16 11:39:09 +00:00			`- TL-WA750RE (v1)`
docs: import v2015.1.2 release notes and list of supported devices 2015-08-09 12:56:03 +00:00			`- TL-WA801N/ND (v1, v2)`
			`- TL-WA830RE (v1, v2)`
docs: update list of supported devices 2014-12-16 11:39:09 +00:00			`- TL-WA850RE (v1)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- TL-WA860RE (v1)`
docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`- TL-WA901N/ND (v1, v2, v3)`
docs: update list of supported devices 2014-12-16 11:39:09 +00:00			`- TL-WDR3500 (v1)`
			`- TL-WDR3600 (v1)`
			`- TL-WDR4300 (v1)`
			`- TL-WR703N (v1)`
docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`- TL-WR710N (v1, v2)`
docs: import v2015.1.2 release notes and list of supported devices 2015-08-09 12:56:03 +00:00			`- TL-WR740N (v1, v3, v4, v5)`
			`- TL-WR741N/ND (v1, v2, v4, v5)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- TL-WR743N/ND (v1, v2)`
docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`- TL-WR801N/ND (v1, v2)`
docs: add TL-WR841 v10 to device list 2015-10-22 21:53:20 +00:00			`- TL-WR841N/ND (v3, v5, v7, v8, v9, v10)`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`- TL-WR842N/ND (v1, v2)`
docs: add TP-Link TL-WR843N/ND 2016-01-30 01:01:21 +00:00			`- TL-WR843N/ND (v1)`
docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`- TL-WR940N (v1, v2, v3)`
			`- TL-WR941ND (v2, v3, v4, v5, v6)`
			`- TL-WR1043N/ND (v1, v2, v3)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- TL-WR2543N/ND (v1)`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00
			`* Ubiquiti`

docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`- Air Gateway`
add support for ubiquiti airRouter 2016-01-17 15:33:49 +00:00			`- Air Router`
docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`- Bullet M`
			`- Nanostation M`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- Nanostation M XW`
			`- Loco M XW`
docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`- Picostation M`
			`- Rocket M`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`- UniFi AP`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- UniFi AP Pro`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`- UniFi AP Outdoor`
docs: add UniFi AP Outdoor+ to list of supported devices 2016-01-17 22:23:42 +00:00			`- UniFi AP Outdoor+`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00
docs: add WD My Net N600/N750 to list of supported devices 2015-11-24 03:10:07 +00:00			`* Western Digital`

			`- My Net N600`
			`- My Net N750`

update the table of supported hardware 2015-04-30 20:20:32 +00:00			`ar71xx-nand`
			`^^^^^^^^^^^`

			`* Netgear`
docs: fix hardware list formatting 2015-04-30 23:16:31 +00:00
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- WNDR3700 (v4)`
docs: hardware support list fixes 2015-05-15 22:23:12 +00:00			`- WNDR4300 (v1)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00
			`mpc85xx-generic`
			`^^^^^^^^^^^^^^^`

			`* TP-Link`
docs: fix hardware list formatting 2015-04-30 23:16:31 +00:00
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- TL-WDR4900 (v1)`

			`x86-generic`
			`^^^^^^^^^^^`
			`* x86-generic`
			`* x86-virtualbox`
			`* x86-vmware`

docs: user/x86 Fixes #373 2015-05-16 13:02:47 +00:00			See also: :doc:`user/x86`

update the table of supported hardware 2015-04-30 20:20:32 +00:00			`x86-kvm_guest`
			`^^^^^^^^^^^^^`
			`* x86-kvm`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00
docs: user/x86 Fixes #373 2015-05-16 13:02:47 +00:00			See also: :doc:`user/x86`

docs: update list of supported hardware Also * create list of newly supported devices since v2015.1.2 in the v2015.2 release notes * update information on docs/user/x86 * fix a comment in targets/ar71xx-generic/profiles.mk 2015-11-23 00:43:35 +00:00			`x86-xen_domu`
			`^^^^^^^^^^^^`
			`* x86-xen`

			See also: :doc:`user/x86`

			`x86-64`
			`^^^^^^`
			`* x86-64-generic`
			`* x86-64-virtualbox`
			`* x86-64-vmware`

			See also: :doc:`user/x86`

docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`License`
			`-------`

			`See LICENCE_`

			`.. _LICENCE: https://github.com/freifunk-gluon/gluon/blob/master/LICENSE`

docs: initial sphinx project with very little content 2014-02-20 16:22:06 +00:00			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`search`