diff --git a/docs/dev/web/config-mode.rst b/docs/dev/web/config-mode.rst index 9c708fb9ff8cd1c3888a2cbd473ba824a386db8f..0a223f97231498e0237eb956bfbb2e6c12acb6b0 100644 --- a/docs/dev/web/config-mode.rst +++ b/docs/dev/web/config-mode.rst @@ -11,18 +11,28 @@ gluon-config-mode-core gluon-config-mode-hostname Provides a hostname field. -gluon-config-mode-autoupdater +:doc:`gluon-config-mode-autoupdater <../../features/autoupdater>` Informs whether the autoupdater is enabled. -gluon-config-mode-mesh-vpn - Allows toggling of mesh-vpn-fastd and setting a bandwidth limit. +:doc:`gluon-config-mode-mesh-vpn <../../features/vpn>` + Allows toggling of installed mesh-vpn technology and setting a bandwidth limit. gluon-config-mode-geo-location Enables the user to set the geographical location of the node. +:doc:`../../package/gluon-config-mode-geo-location-osm` + Lets the user click on a map to select the geographical location through a OSM map + gluon-config-mode-contact-info Adds a field where the user can provide contact information. +:doc:`../../package/gluon-web-cellular` + Adds advanced options to enter WWAN config. + +:doc:`../../package/gluon-web-network` + Adds option to configure used role on interfaces + +Most of the configuration options are described in :ref:`user-site-config_mode` Writing Config Mode modules ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/features/autoupdater.rst b/docs/features/autoupdater.rst index 545b8237d018ec86e53ba8bd045fddba203bd4dd..037563c22dc0b7104f86483654a1190e6651b5eb 100644 --- a/docs/features/autoupdater.rst +++ b/docs/features/autoupdater.rst @@ -31,7 +31,7 @@ as otherwise the generated manifest will be incomplete. Manifest format ------------------------- +--------------- The manifest starts with a short header, followed by the list of firmwares and signatures. The header contains the following information: diff --git a/docs/features/configmode.png b/docs/features/configmode.png new file mode 100644 index 0000000000000000000000000000000000000000..4cf87e0ce73f876004e5e37b4cbb55f693fe219e Binary files /dev/null and b/docs/features/configmode.png differ diff --git a/docs/features/configmode.rst b/docs/features/configmode.rst index 58e3ccd57bf885dc8103fd709b81ed3edf351ac0..ea27338754ae50b824bc65a2053887f590d62876 100644 --- a/docs/features/configmode.rst +++ b/docs/features/configmode.rst @@ -38,3 +38,17 @@ Accessing Config Mode Config Mode can be accessed at http://192.168.1.1. The node will offer DHCP to clients. Should this fail, you may assign an IP from 192.168.1.0/24 to your computer manually. + +.. image:: configmode.png + +Advanced Config Options +----------------------- + +Depending on the installed packages, the advanced config mode allows to configure packages further. + +* :doc:`gluon-web-wifi-config enable <wlan-configuration>` radios used for wifi and mesh as well as outdoor mode +* :doc:`../package/gluon-web-network` allows to configure the used roles (uplink, mesh, client) on each interface +* :doc:`../package/gluon-web-admin` allows to enter SSH keys or set a password in the `Remote access` section +* :doc:`../package/gluon-web-cellular` allows to configure SIM card / WWAN settings on supported cellular devices + +The advanced config does also allow to upload a sysupgrade file to update the firmware to a different version. diff --git a/docs/features/status-page.png b/docs/features/status-page.png new file mode 100644 index 0000000000000000000000000000000000000000..604651b25fbee1118a1803639ff33d467d7afab3 Binary files /dev/null and b/docs/features/status-page.png differ diff --git a/docs/features/status-page.rst b/docs/features/status-page.rst new file mode 100644 index 0000000000000000000000000000000000000000..b38a1506a50a6f14cb6566c20bc45a12a749066c --- /dev/null +++ b/docs/features/status-page.rst @@ -0,0 +1,30 @@ +Status-Page +=========== + +When the feature ``gluon-status-page`` is enabled, Gluon nodes run a HTTP server with status information on all IP addresses of ``br-client``. +This makes it possible to check information of the node in realtime. + +If the mesh protocol ``gluon-mesh-batman-adv`` is installed too, the package ``gluon-status-page-mesh-batman-adv`` is added too according to the :ref:`user-site-feature-flags` + +.. _status-page-example-picture: + +Example Picture +--------------- + +The left side of the status page contains Overview information. +In the middle, current monitoring information abut the system, number of clients, radios, amount of traffic and connected mesh-vpn if any are shown. +The right side of the Status-Page contains information about Neighbours to this node through :doc:`wired-mesh` as well as wireless mesh. + +.. image:: status-page.png + +Mesh Graphs +----------- + +When wireless mesh is enabled, the mesh interfaces show realtime Graphs about the received signal strength (RSSI) in dBm. + +Neighbours +---------- + +The list of neighbours at first shows the mac-address of the neighbour it sees. +The status-page sends a second request to ``http://[ipv6]/cgi-bin/dyn/neighbours-nodeinfo?mesh-vpn`` which triggers the lookup of neighbour information on the node itself. +Through this, the actual nodenames of the neighbours are shown on the status-page as can be seen in the :ref:`status-page-example-picture`. diff --git a/docs/features/tls.rst b/docs/features/tls.rst new file mode 100644 index 0000000000000000000000000000000000000000..d6b2a396a35c7ede84eb0444a095dc7df9398bf6 --- /dev/null +++ b/docs/features/tls.rst @@ -0,0 +1,10 @@ +TLS support +=========== + +The generic TLS implementation which is currently used by OpenWRT can be installed or added as dependency through the package ``gluon-tls``. +This removes the need for community packages to depend on a specific TLS implementation (like mbedtls, OpenSSL or WolfSSL). + +This package is an alias for the current TLS implementation used. +To allow for easy usage of communicating through HTTPS from the node, typical Certificate Authorities (CAs) are included through the package ``ca-bundle`` . + +* Starting with OpenWRT 23.05, mbedtls is the default TLS layer - this is reflected in Gluon :ref:`v2023.2 <releases-v2023.2-minor-changes>`. HTTPS is used by default to communicate with OpenWRT opkg servers. diff --git a/docs/features/wlan-configuration.rst b/docs/features/wlan-configuration.rst index e721954e8cb65bac61941bd899981802fd9f39af..4d6988355e6107c1faa94baf0c8c9ba8dc2f6475 100644 --- a/docs/features/wlan-configuration.rst +++ b/docs/features/wlan-configuration.rst @@ -6,6 +6,13 @@ may include one or both of the two networks "client" (AP mode) and "mesh" (802.1 mode), which can be used simultaneously. See :doc:`../user/site` for details on the configuration. +Outdoor mode +------------ + +Configuring the node for outdoor use tunes the 5 GHz radio to a frequency and transmission power that conforms with the local regulatory requirements. +It also enables dynamic frequency selection (DFS; radar detection). +At the same time, mesh functionality is disabled as it requires neighbouring nodes to stay on the same channel permanently. + Upgrade behaviour ----------------- diff --git a/docs/index.rst b/docs/index.rst index 7f2f7cec50b16fff15a37a63e56fafa3ba00a20d..e194555917d85f6f450e892ec44554dfa7e828b7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,12 +25,14 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre features/wlan-configuration features/private-wlan features/wired-mesh + features/tls features/dns-cache features/monitoring features/multidomain features/authorized-keys features/roles features/vpn + features/status-page .. toctree:: :caption: Developer Documentation @@ -62,6 +64,7 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre package/gluon-client-bridge package/gluon-config-mode-domain-select + package/gluon-config-mode-geo-location-osm package/gluon-ebtables-filter-multicast package/gluon-ebtables-filter-ra-dhcp package/gluon-ebtables-limit-arp @@ -73,6 +76,8 @@ Several Freifunk communities in Germany use Gluon as the foundation of their Fre package/gluon-radv-filterd package/gluon-scheduled-domain-switch package/gluon-web-admin + package/gluon-web-cellular + package/gluon-web-network package/gluon-web-logging .. toctree:: diff --git a/docs/package/gluon-config-mode-geo-location-osm.png b/docs/package/gluon-config-mode-geo-location-osm.png new file mode 100644 index 0000000000000000000000000000000000000000..f03226049f326a920fe07d95b7ef572534b02025 Binary files /dev/null and b/docs/package/gluon-config-mode-geo-location-osm.png differ diff --git a/docs/package/gluon-config-mode-geo-location-osm.rst b/docs/package/gluon-config-mode-geo-location-osm.rst new file mode 100644 index 0000000000000000000000000000000000000000..5b0b9eaad8a717d5b4babdfd1dd567c2726f7832 --- /dev/null +++ b/docs/package/gluon-config-mode-geo-location-osm.rst @@ -0,0 +1,11 @@ +.. _package-gluon-config-mode-geo-location-osm: + +gluon-config-mode-geo-location-osm +================================== + +When package *gluon-config-mode-geo-location-osm* is enabled, the configuration wizard will +try to load an OSM-based map to allow the user to specify the node location. +Loading the map requires a working internet connection, for example via WLAN +(while connected to the Gluon node via Ethernet). + +.. image:: gluon-config-mode-geo-location-osm.png diff --git a/docs/package/gluon-web-cellular.png b/docs/package/gluon-web-cellular.png new file mode 100644 index 0000000000000000000000000000000000000000..3bef795bd996d1b4211adbf743543d411cd619a2 Binary files /dev/null and b/docs/package/gluon-web-cellular.png differ diff --git a/docs/package/gluon-web-cellular.rst b/docs/package/gluon-web-cellular.rst new file mode 100644 index 0000000000000000000000000000000000000000..3165a40223cb684728f9d8e703f030b17ad2a421 --- /dev/null +++ b/docs/package/gluon-web-cellular.rst @@ -0,0 +1,14 @@ +.. _package-gluon-web-cellular: + +gluon-web-cellular +================== + +This package allows to configure WWAN for capable cellular devices. + +This works by creating an abstraction layer into Gluon which takes common options (SIM PIN / APN) and translates it to modem-specific settings based on the specific device using. +Doing so limits the use-case onto specific models (no LTE sticks possible) but provides a common interface. + +The WWAN is assigned the WAN firewall zone and wired WAN can still be used, however without prioritization. +The traffic path is not configured to prefer one uplink source or the other. + +.. image:: gluon-web-cellular.png diff --git a/docs/package/gluon-web-network.png b/docs/package/gluon-web-network.png new file mode 100644 index 0000000000000000000000000000000000000000..f82251ac61f4964d995162d1cdd27eca3c1404a9 Binary files /dev/null and b/docs/package/gluon-web-network.png differ diff --git a/docs/package/gluon-web-network.rst b/docs/package/gluon-web-network.rst new file mode 100644 index 0000000000000000000000000000000000000000..05625e2c0292861b0a4c34018a545259031519cf --- /dev/null +++ b/docs/package/gluon-web-network.rst @@ -0,0 +1,19 @@ +gluon-web-network +================= + +The package *gluon-web-network* is part of :ref:`Feature Flag <user-site-feature-flags>` web-advanced. +It allows to configure the network interfaces roles of the gluon node in config mode through checkboxes. + +It is a user-friendly way to configure what otherwise would need the :ref:`wired-mesh-commandline`. + +.. image:: gluon-web-network.png + +configuration options +--------------------- + +The following roles can be assigned to the interfaces: +* `Uplink` - interface is used for WAN connection, which is used for the VPN if `mesh-vpn` checkbox is enabled in basic config mode +* `Mesh` - interface is used for :doc:`../features/wired-mesh`. Using this on the WAN interface is also known as "Mesh-on-WAN" +* `Client` - interface is used as client network - connected devices to this interface should get a working internet configuration through DHCP + +The roles `Uplink`/`Mesh` and `Client` are mutually exclusive. diff --git a/docs/releases/v2023.2.rst b/docs/releases/v2023.2.rst index 3d5969d98064694b695046c35f32262e719202ff..d34ad45b659be7c3b5d8b5ac44d8012756105ff0 100644 --- a/docs/releases/v2023.2.rst +++ b/docs/releases/v2023.2.rst @@ -288,6 +288,7 @@ Major changes This release is based on the newest OpenWrt 23.05 release branch. It ships with Linux kernel 5.15.y, wireless-backports 6.1.24 and batman-adv 2023.1. +.. _releases-v2023.2-minor-changes: Minor changes ------------- diff --git a/docs/user/x86.rst b/docs/user/x86.rst index e2587463a5daebb03a40d8844cfa7d2bb5a42db8..20f3235fafdea9870f9a8596f193e60f9fd362b6 100644 --- a/docs/user/x86.rst +++ b/docs/user/x86.rst @@ -9,9 +9,9 @@ Targets The following targets for x86 images exist: -`x86-generic` - Generic x86 support with many different ethernet drivers; should run on - most x86 systems. +`x86-64` + Generic x86 64-bit support with many different ethernet drivers; should run on + most x86 systems with 64-bit support. There are three images: @@ -20,10 +20,15 @@ The following targets for x86 images exist: * `vmware` (VMDK image) These images differ in the image file format, the content is the same. Therefore - a single `x86-generic` sysupgrade image is provided, only. + a single `x86-64` sysupgrade image is provided, only. + +`x86-generic` + 32-bit version of `x86-64` for hardware not supporting 64-bit images. + Also comes with `virtualbox` and `vmware` factory installs. `x86-geode` x86 image for Geode CPUs. -`x86-64` - 64bit version of `x86-generic`. +`x86-legacy` + x86 image for very old PC hardware like i586. +