gluon/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/faq

Features
--------

.. toctree::
   :maxdepth: 2

   features/configmode
   features/autoupdater
   features/private-wlan
   features/mesh-on-wan
   features/announce
   features/authorized-keys
   features/roles

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

.. toctree::
   :maxdepth: 2

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

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

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

* Allnet
  - ALL0315N

* Buffalo

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

* D-Link

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

* GL-Inet
  - 6408A (v1)
  - 6416a (v1)

* Linksys

  - WRT160NL

* Netgear
  - WNDR3700 (v1, v2)
  - WNDR3800

* TP-Link

  - CPE210 (v1)
  - CPE220 (v1)
  - CPE510 (v1)
  - CPE520 (v1)
  - TL-MR3020 (v1)
  - TL-MR3040 (v1, v2)
  - TL-MR3220 (v1, v2)
  - TL-MR3420 (v1, v2)
  - TL-WA701N/ND (v1)
  - TL-WA750RE (v1)
  - TL-WA801N/ND (v2)
  - TL-WA850RE (v1)
  - TL-WA860RE (v1)
  - TL-WA901N/ND (v2, v3)
  - TL-WDR3500 (v1)
  - TL-WDR3600 (v1)
  - TL-WDR4300 (v1)
  - TL-WR1043N/ND (v1, v2)
  - TL-WR703N (v1)
  - TL-WR710N (v1)
  - TL-WR740N (v1, v3, v4)
  - TL-WR741N/ND (v1, v2, v4)
  - TL-WR743N/ND (v1, v2)
  - TL-WR841N/ND (v3, v5, v7, v8, v9)
  - TL-WR842N/ND (v1, v2)
  - TL-WR941N/ND (v2, v3, v4, v5)
  - TL-WR2543N/ND (v1)

* Ubiquiti

  - Bullet M2
  - Nanostation M2
  - Nanostation M XW
  - Loco M XW
  - Picostation M2
  - Rocket M2
  - UniFi AP
  - UniFi AP Pro
  - UniFi AP Outdoor

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

* Netgear
  - WNDR3700 (v4)
  - WNDR3700 (v1)

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

* TP-Link
  - TL-WDR4900 (v1)

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

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

Releases
--------

.. toctree::
   :maxdepth: 1

   releases/v2015.1
   releases/v2014.4
   releases/v2014.3.1
   releases/v2014.3


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: 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 private WLAN 2014-08-05 21:30:16 +00:00			`features/private-wlan`
gluon-batman-on-wan: docs 2014-07-16 12:59:26 +00:00			`features/mesh-on-wan`
docs: gluon-announce, announced, alfred 2014-07-21 11:30:17 +00:00			`features/announce`
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
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`Supported Devices & Architectures`
			`---------------------------------`

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

			`* Allnet`
			`- 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`
			`- WZR-HP-G450H`

			`* D-Link`

			`- DIR-825 (B1)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- DIR-615 (C1)`

			`* GL-Inet`
			`- 6408A (v1)`
			`- 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`
			`- WNDR3700 (v1, v2)`
			`- WNDR3800`

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 devices 2014-12-16 11:39:09 +00:00			`- CPE210 (v1)`
			`- CPE220 (v1)`
			`- CPE510 (v1)`
			`- CPE520 (v1)`
			`- 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)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- TL-WA701N/ND (v1)`
docs: update list of supported devices 2014-12-16 11:39:09 +00:00			`- TL-WA750RE (v1)`
docs: update supported devices, reorder them alphabetically and fix a model name 2014-12-17 19:22:59 +00:00			`- TL-WA801N/ND (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)`
			`- TL-WA901N/ND (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-WR1043N/ND (v1, v2)`
			`- TL-WR703N (v1)`
			`- TL-WR710N (v1)`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`- TL-WR740N (v1, v3, v4)`
			`- TL-WR741N/ND (v1, v2, v4)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- TL-WR743N/ND (v1, v2)`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`- TL-WR841N/ND (v3, v5, v7, v8, v9)`
			`- TL-WR842N/ND (v1, v2)`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- TL-WR941N/ND (v2, v3, v4, v5)`
			`- TL-WR2543N/ND (v1)`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00
			`* Ubiquiti`

			`- Bullet M2`
			`- Nanostation M2`
update the table of supported hardware 2015-04-30 20:20:32 +00:00			`- Nanostation M XW`
			`- Loco M XW`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00			`- Picostation M2`
docs: add Rocket M2 to list of supported devices 2015-04-25 17:38:02 +00:00			`- Rocket M2`
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`

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

			`* Netgear`
			`- WNDR3700 (v4)`
			`- WNDR3700 (v1)`

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

			`* TP-Link`
			`- TL-WDR4900 (v1)`

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

			`x86-kvm_guest`
			`^^^^^^^^^^^^^`
			`* x86-kvm`
docs: clean up index page, add list of supported devices 2014-08-02 17:49:50 +00:00
docs: add 2014.3 release notes 2014-08-02 19:33:10 +00:00			`Releases`
			`--------`

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

docs: add releases/v2015.1 to TOC tree 2015-03-25 17:54:52 +00:00			`releases/v2015.1`
docs: add preliminary v2014.4 release notes It's much nicer to fill in the release notes piece by piece as v2014.4 is developed, so let's start with the new modular config mode. 2014-08-06 09:37:18 +00:00			`releases/v2014.4`
release notes for 2014.3.1 2014-10-17 12:31:12 +00:00			`releases/v2014.3.1`
docs: add 2014.3 release notes 2014-08-02 19:33:10 +00:00			`releases/v2014.3`


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`