nils/gluon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
850499fdb3
gluon/docs/index.rst

290 lines
4.4 KiB
ReStructuredText
Raw Normal View History

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
Reorganize MAC addresses, always explicitly set address for private WLAN Fixes #842
2016-08-30 22:37:59 +00:00
dev/mac_addresses
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: fix gluon-config-mode-contact-info syntax errors and formatting
2016-09-09 01:00:54 +00:00
package/gluon-config-mode-contact-info
gluon-config-mode-geo-location: add ability to hide the altitude field (#693)
2016-04-27 10:37:30 +00:00
package/gluon-config-mode-geo-location
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
docs: add package/gluon-ebtables-segment-mld to index
2016-08-30 21:55:46 +00:00
package/gluon-ebtables-segment-mld
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: add release notes for Gluon v2016.2.2
2016-12-17 02:11:04 +00:00
releases/v2016.2.2
docs, README: import release notes from Gluon v2016.2.1
2016-11-08 16:28:12 +00:00
releases/v2016.2.1
docs: add preliminary release notes for Gluon v2016.2
2016-09-11 17:42:41 +00:00
releases/v2016.2
docs, README: Gluon v2016.1.6
2016-08-30 00:03:43 +00:00
releases/v2016.1.6
docs, README: Gluon v2016.1.5
2016-05-18 23:07:20 +00:00
releases/v2016.1.5
docs, README: Gluon v2016.1.4
2016-04-25 08:17:06 +00:00
releases/v2016.1.4
docs, README: Gluon v2016.1.3
2016-03-31 18:45:35 +00:00
releases/v2016.1.3
docs, README: add release notes for v2016.1.2, update version numbers
2016-03-08 05:51:47 +00:00
releases/v2016.1.2
docs, README: add release notes for v2016.1.1, update version numbers
2016-03-01 23:58:26 +00:00
releases/v2016.1.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
^^^^^^^^^^^^^^
ar71xx-generic: add support for Carambola 2 Device information can be found at: http://www.8devices.com/products/carambola-2 https://wiki.openwrt.org/toh/8devices/carambola2 I only did some minimal testing of gluon on the carambola 2 development board: - Config mode works - Connects to Wifi Mesh - Allows clients to connect Notably, autoupgrade has not yet been tested. Change to 010-primary-mac is necessary as the mac address printed on the sticker is the one of eth0, not the wifi mac.
2016-04-20 13:49:41 +00:00
* 8devices
- Carambola 2
Add Support for the ALFA Hornet UB and similar devices The Hornet UB is sold at least in the varieties. Without case it is a Hornet UB, with case and without connected USB port it is called AP121. If the USB port is present this device is called AP121U. We have a AP121U in our mesh http://meshviewer.chemnitz.freifunk.net/#!v:m;n:00c0ca6efffa
2016-03-13 14:59:47 +00:00
* ALFA Network
- AP121
- AP121U
- Hornet-UB
ar71xx-generic: add support for ALFA N2 and N5 (#871) + added profile for these devices + added entry in the docs for these devices plus the missing alfa tube
2016-08-30 10:18:35 +00:00
- Tube2H
- N2
- N5
Add Support for the ALFA Hornet UB and similar devices The Hornet UB is sold at least in the varieties. Without case it is a Hornet UB, with case and without connected USB port it is called AP121. If the USB port is present this device is called AP121U. We have a AP121U in our mesh http://meshviewer.chemnitz.freifunk.net/#!v:m;n:00c0ca6efffa
2016-03-13 14:59:47 +00:00
update the table of supported hardware
2015-04-30 20:20:32 +00:00
* 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 hardware support list
2016-09-11 15:26:30 +00:00
- WZR-HP-G300NH2
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
ar71xx-generic: add D-Link DIR-505 rev. A2 as alias of D-Link DIR-505 rev. A1
2016-05-08 12:28:28 +00:00
- DIR-505 (A1, A2)
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
docs: update hardware support list
2016-09-11 15:26:30 +00:00
* GL Innovations
docs: fix hardware list formatting
2015-04-30 23:16:31 +00:00
docs: update hardware support list
2016-09-11 15:26:30 +00:00
- GL-AR150
- GL-iNet 6408A (v1)
- GL-iNet 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
ar71xx-generic: Add support for OpenMesh devices Integrate OpenMesh devices available in OpenWrt Chaos Calmer: - MR600 - MR600v2 - MR900 - MR900v2 - OM2P - OM2P-HS - OM2P-HSv2 - OM2P-LC - OM2Pv2 - OM5P - OM5P-AN Signed-off-by: Sven Eckelmann <sven.eckelmann@open-mesh.com>
2016-05-14 19:59:23 +00:00
* OpenMesh
docs: Fix list alignment of OpenMesh devices Signed-off-by: Sven Eckelmann <sven.eckelmann@open-mesh.com>
2016-06-17 11:15:25 +00:00
- MR600 (v1, v2)
- MR900 (v1, v2)
docs: update hardware support list
2016-09-11 15:26:30 +00:00
- MR1750 (v1, v2) [#ath10k]_
docs: Fix list alignment of OpenMesh devices Signed-off-by: Sven Eckelmann <sven.eckelmann@open-mesh.com>
2016-06-17 11:15:25 +00:00
- OM2P (v1, v2)
ar71xx-generic: Add support for OpenMesh OM2P-HSv3 The new OM2P-HSv3 device support is only available in LEDE master. The relevant patches have to backported to add support for them in Gluon Signed-off-by: Sven Eckelmann <sven.eckelmann@open-mesh.com>
2016-06-17 13:34:28 +00:00
- OM2P-HS (v1, v2, v3)
docs: Fix list alignment of OpenMesh devices Signed-off-by: Sven Eckelmann <sven.eckelmann@open-mesh.com>
2016-06-17 11:15:25 +00:00
- OM2P-LC
- OM5P
- OM5P-AN
docs: update hardware support list
2016-09-11 15:26:30 +00:00
- OM5P-AC (v1, v2) [#ath10k]_
ar71xx-generic: Add support for OpenMesh devices Integrate OpenMesh devices available in OpenWrt Chaos Calmer: - MR600 - MR600v2 - MR900 - MR900v2 - OM2P - OM2P-HS - OM2P-HSv2 - OM2P-LC - OM2Pv2 - OM5P - OM5P-AN Signed-off-by: Sven Eckelmann <sven.eckelmann@open-mesh.com>
2016-05-14 19:59:23 +00:00
docs: clean up index page, add list of supported devices
2014-08-02 17:49:50 +00:00
* TP-Link
docs: update hardware support list
2016-09-11 15:26:30 +00:00
- Archer C5 (v1) [#ath10k]_
- Archer C7 (v2) [#ath10k]_
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)
Add support for TP-Link TL-WA7510N This CPE is supported by OpenWRT and already running in Chemnitz
2016-03-09 21:17:06 +00:00
- TL-WA7510N (v1)
docs: index: add TP-Link TL-WA801N/ND v3 to hardware list
2016-12-17 02:11:41 +00:00
- TL-WA801N/ND (v1, v2, v3)
docs: import v2015.1.2 release notes and list of supported devices
2015-08-09 12:56:03 +00:00
- 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)
ar71xx-generic: set region code for TL-WA901ND v4 and remove BROKEN Tested-by: Jannis Pinter <jannis@pinterjann.is>
2016-10-15 17:11:35 +00:00
- TL-WA901N/ND (v1, v2, v3, v4)
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 hardware support list
2016-09-11 15:26:30 +00:00
- TL-WR710N (v1, v2, v2.1)
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)
ar71xx-generic: remove BROKEN for TL-WR841N/ND v11
2016-04-29 15:44:04 +00:00
- TL-WR841N/ND (v3, v5, v7, v8, v9, v10, v11)
docs: update hardware support list
2016-09-11 15:26:30 +00:00
- TL-WR842N/ND (v1, v2, v3)
docs: add TP-Link TL-WR843N/ND
2016-01-30 01:01:21 +00:00
- TL-WR843N/ND (v1)
docs: add TP-Link TL-WR940N v4 to hardware list
2016-12-19 14:09:24 +00:00
- TL-WR940N (v1, v2, v3, v4)
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-WR941ND (v2, v3, v4, v5, v6)
ar71xx-generic: backport support for TP-LINK TL-WR1043ND v4 Fixes #961
2016-12-21 18:59:49 +00:00
- TL-WR1043N/ND (v1, v2, v3, v4)
update the table of supported hardware
2015-04-30 20:20:32 +00:00
- TL-WR2543N/ND (v1)
ar71xx-generic: TP-Link WBS210/510: remove BROKEN (#1002)
2017-01-09 21:25:16 +00:00
- WBS210 (v1.20)
- WBS510 (v1.20)
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 hardware support list
2016-09-11 15:26:30 +00:00
- Bullet M2/M5
- Loco M2/M5
- Loco M2/M5 XW
- Nanostation M2/M5
- Nanostation M2/M5 XW
- Picostation M2/M5
- Rocket M2/M5
- Rocket M2/M5 XW
docs: clean up index page, add list of supported devices
2014-08-02 17:49:50 +00:00
- UniFi AP
docs: update hardware support list
2016-09-11 15:26:30 +00:00
- UniFi AP AC Lite [#ath10k]_
- UniFi AP AC Pro [#ath10k]_
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
docs: update hardware support list
2016-09-11 15:26:30 +00:00
.. [#ath10k]
Device uses the ath10k WLAN driver; no image is built unless GLUON_ATH10K_MESH
docs: fix and update make variable section
2016-09-11 16:05:28 +00:00
is set as described in :ref:`getting-started-make-variables`
docs: update hardware support list
2016-09-11 15:26:30 +00:00
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
docs: update hardware support list
2016-09-11 15:26:30 +00:00
brcm2708-bcm2708
^^^^^^^^^^^^^^^^
docs: add missing newlines in index
2016-09-11 16:15:48 +00:00
docs: update hardware support list
2016-09-11 15:26:30 +00:00
* RaspberryPi 1
brcm2708-bcm2709
^^^^^^^^^^^^^^^^
docs: add missing newlines in index
2016-09-11 16:15:48 +00:00
docs: update hardware support list
2016-09-11 15:26:30 +00:00
* RaspberryPi 2
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
^^^^^^^^^^^
docs: add missing newlines in index
2016-09-11 16:15:48 +00:00
update the table of supported hardware
2015-04-30 20:20:32 +00:00
* 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
^^^^^^^^^^^^^
docs: add missing newlines in index
2016-09-11 16:15:48 +00:00
update the table of supported hardware
2015-04-30 20:20:32 +00:00
* 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
^^^^^^^^^^^^
docs: add missing newlines in index
2016-09-11 16:15:48 +00:00
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
See also: :doc:`user/x86`
x86-64
^^^^^^
docs: add missing newlines in index
2016-09-11 16:15:48 +00:00
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-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`
Reference in New Issue Copy Permalink