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

94 lines
1.8 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: fix typos and common misspellings (#1668)
2019-03-10 19:15:25 +00:00
Gluon is a modular framework for creating OpenWrt-based firmware images for wireless mesh nodes.
Several Freifunk communities in Germany use Gluon as the foundation of their Freifunk firmware.
docs: initial sphinx project with very little content
2014-02-20 16:22:06 +00:00
.. toctree::
docs: restructure index for better readability in readthedocs theme
2017-04-10 14:22:14 +00:00
:caption: User Documentation
docs: initial sphinx project with very little content
2014-02-20 16:22:06 +00:00
: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: move supported devices to own page (#1797)
2019-08-21 21:46:08 +00:00
user/supported_devices
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
.. toctree::
docs: restructure index for better readability in readthedocs theme
2017-04-10 14:22:14 +00:00
:caption: Features
docs: initial sphinx project with very little content
2014-02-20 16:22:06 +00:00
: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
gluon-core: remove DNS cache feature dnsmasq's caching is severly broken and does not handle all answer records equally. In particular, its cached answers are missing DNSKEY and DS records, breaking DNSSEC validation on clients. Remove the cache for now. It may return if dnsmasq is fixed or we switch to a different resolver.
2018-04-13 13:15:40 +00:00
features/dns-forwarder
docs: update outdated monitoring documentation
2016-02-05 10:00:38 +00:00
features/monitoring
docs: add documentation about multidomain support (#1365)
2018-06-13 22:01:56 +00:00
features/multidomain
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: add features/vpn to index (#1330)
2018-02-20 12:25:43 +00:00
features/vpn
docs: initial sphinx project with very little content
2014-02-20 16:22:06 +00:00
.. toctree::
docs: restructure index for better readability in readthedocs theme
2017-04-10 14:22:14 +00:00
:caption: Developer Documentation
docs: initial sphinx project with very little content
2014-02-20 16:22:06 +00:00
: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
docs: add new doc page about package development Explain the magic of gluon.mk. The feature flag documention is moved into this new page.
2018-06-23 17:44:43 +00:00
dev/packages
Documentation and helper script for the new upgrade script handling
2015-01-23 02:29:37 +00:00
dev/upgrade
docs: update for role-based interface configuration
2022-01-23 23:18:02 +00:00
dev/uplink
Reorganize MAC addresses, always explicitly set address for private WLAN Fixes #842
2016-08-30 22:37:59 +00:00
dev/mac_addresses
docs: add documentation for site library
2018-07-07 09:43:18 +00:00
dev/site_library
docs: start doc page on the build system
2020-03-07 15:02:24 +00:00
dev/build
openwrt: Store Kernel Debug-Info (#1971) This change stores a Kernel with Debug-Symbols for the current architecture in a new output directory '<outputdir>/debug'. This allows a developer or operator of a network to store the kernel along with the actual images. In case of a kernel oops the debug information can be used with the script 'scripts/decode_stacktrace.sh' in the kernel source tree to get the names to the symbols of the stack trace. OpenWRT already provides the CONFIG_COLLECT_KERNEL_DEBUG -option that creates a kernel with debug-symbols in the OpenWRT output directory. This change enables this option and copies the generated kernel to the gluon output directory. Signed-off-by: Chrissi^ <chris@tinyhost.de>
2020-06-04 20:35:58 +00:00
dev/debugging
docs: initial sphinx project with very little content
2014-02-20 16:22:06 +00:00
docs: add documentation for gluon-web
2017-02-09 06:09:55 +00:00
.. toctree::
docs: restructure index for better readability in readthedocs theme
2017-04-10 14:22:14 +00:00
:caption: gluon-web Reference
docs: add documentation for gluon-web
2017-02-09 06:09:55 +00:00
:maxdepth: 1
dev/web/controller
dev/web/model
dev/web/view
dev/web/i18n
dev/web/config-mode
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
.. toctree::
docs: restructure index for better readability in readthedocs theme
2017-04-10 14:22:14 +00:00
:caption: Packages
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
:maxdepth: 1
package/gluon-client-bridge
gluon-config-mode-domain-select: new package [Matthias Schiffer: slightly clean up code]
2018-02-02 20:33:17 +00:00
package/gluon-config-mode-domain-select
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-limit-arp (#1386) based on package documentation, authored by T_X https://github.com/freifunk-gluon/gluon/blob/84a6f65f02d7e36a073ba2839712f0c0bb1dda10/package/gluon-ebtables-limit-arp/Makefile#L18-L39 fixes #1383
2018-05-17 00:02:15 +00:00
package/gluon-ebtables-limit-arp
docs: add missing link to gluon-ebtables-source-filter
2017-04-10 11:28:25 +00:00
package/gluon-ebtables-source-filter
gluon-hoodselector docs: add package documentation Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> gluon-hoodselector docs: replace 'Router have' with 'Router has' gluon-hoodselector: docs: fix spelling/grammar docs: gluon-hoodselector.rst, chnage 'VPN-mode' to VPN mode and 'trigon polygon' to triangle Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs/package/gluon-hoodselector: update .dia and .svg to current code behave Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs/package/gluon-hoodselector: replace hood with domain update doc to current code behave Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs hoodselector: fix spelling Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs/package/gluon-hoodselector: fix spelling second round Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs:gluon-hoodselector.rst: fix spelling Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs gluon-hoodselector.rst: fix line length Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs gluon-hoodselector: rename doc imports to be assoziated with the hoodselector docs gluon-hoodselector: fix image name and rst inmport Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs gluon-hoodselector: information without es (uncountable) Signed-off-by: Jan-Tarek Butt <tarek@ring0.de> docs/package: gluon-hoodselector.rst fix grammer issues Signed-off-by: Jan-Tarek Butt <tarek@ring0.de>
2018-07-15 09:26:00 +00:00
package/gluon-hoodselector
add gluon-logging package Allows reconfigurtion of remote syslog from within site.conf. Conflicts with the gluon-web-logging package as user made changes will be overwritten, because this package will reconfigure the syslog destination on every upgrade. Resolves #1845
2020-04-05 19:32:41 +00:00
package/gluon-logging
docs: Add documentation for gluon-mesh-batman-adv (#1810) This adds documentation for the gluon-mesh-batman-adv package and elaborates on its build and configuration options, as well as the implemented multicast architecture. Signed-off-by: Linus Lüssing <linus.luessing@c0d3.blue>
2019-09-10 21:55:06 +00:00
package/gluon-mesh-batman-adv
Add gluon-mesh-wireless-sae package This package adds support for SAE on 802.11s mesh connections. Enabling this package will require all 802.11s mesh connections to be encrypted using the SAE key agreement scheme. The security of SAE relies upon the authentication through a shared secret. In the context of public mesh networks a shared secret is an obvious oxymoron. Still this functionality provides an improvement over unencrypted mesh connections in that it protects against a passive attacker who did not observe the key agreement. In addition Management Frame Protection (802.11w) gets automatically enabled on mesh interfaces to prevent protocol-level deauthentication attacks. If `wifi.mesh.sae` is enabled a shared secret will automatically be derived from the `prefix6` variable. This is as secure as it gets for a public mesh network. For *private* mesh networks `wifi.mesh.sae_passphrase` should be set to your shared secret. Fixes #1636
2019-02-05 01:34:12 +00:00
package/gluon-mesh-wireless-sae
Add package gluon-radv-filterd This package drops all incoming router advertisements except for the default router with the best metric according to B.A.T.M.A.N. advanced. Note that advertisements originating from the node itself (for example via gluon-radvd) are not affected.
2016-07-29 22:19:06 +00:00
package/gluon-radv-filterd
docs: link gluon-scheduled-domain-switch in nav
2019-02-16 15:50:30 +00:00
package/gluon-scheduled-domain-switch
gluon-web-admin: add option to show/hide password-login and add minimum password length
2017-06-22 22:17:37 +00:00
package/gluon-web-admin
docs: add package/gluon-web-logging to index
2018-01-09 22:12:28 +00:00
package/gluon-web-logging
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
.. toctree::
docs: restructure index for better readability in readthedocs theme
2017-04-10 14:22:14 +00:00
:caption: Releases
docs: reorder index to make the release notes more prominent
2015-04-30 23:14:57 +00:00
:maxdepth: 1
docs: move release notes TOC to sub page (#2408) This allows us to organize the TOC a bit better by adding sections per major version. We can even increase the maxdepth to 2 now, which looks great in my opinion. In addition, the full list of releases is not shown in the sidebar anymore when viewing a completely different part of the documentation, which took up more than half of the total sidebar entries.
2022-03-23 19:26:56 +00:00
releases/index
docs: reorder index to make the release notes more prominent
2015-04-30 23:14:57 +00:00
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:`search`
Reference in New Issue Copy Permalink