newUI-5
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 43 KiB |
After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 97 KiB |
After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 7.8 KiB |
After Width: | Height: | Size: 22 KiB |
After Width: | Height: | Size: 83 KiB |
|
@ -352,4 +352,4 @@ After the node reboots, it should have a default IP address of 192.168.1.1. Make
|
|||
|
||||
Once your device is running AREDN |trade| firmware, you can display its web interface by navigating to either ``http://192.168.1.1`` or ``http://localnode.local.mesh``. Some computers may have DNS search paths configured that require you to use the `fully qualified domain name (FQDN) <https://en.wikipedia.org/wiki/Fully_qualified_domain_name>`_ to resolve *localnode* to the mesh node's IP address. You may need to clear your web browser's cache in order to remove any cached pages.
|
||||
|
||||
You can use your web browser to configure the new node with your callsign, admin password, and other settings as described in the **Basic Radio Setup** section of the documentation.
|
||||
You can use your web browser to configure the new node with your callsign, admin password, and other settings as described in the **Firstboot Node Setup** section of the documentation.
|
||||
|
|
|
@ -2,86 +2,24 @@
|
|||
Mesh Status Display
|
||||
===================
|
||||
|
||||
The **Mesh Status** page lists mesh nodes and link quality information, along with any LAN hosts and advertised services available on the network. Below the node name bar there are several controls.
|
||||
|icon4| You navigate to the **mesh status** page by clicking the mesh icon in the left nav bar.
|
||||
|
||||
- The **Refresh** button refreshes the *Mesh Status* display with current information.
|
||||
|
||||
- The **Auto** button sets the display to automatically refresh the node information every 10 seconds. To end auto-refresh mode, click **Stop** or **Quit**. *Stop* returns to the static *Mesh Status* display. *Quit* takes you back to the *Node Status* display, but clicking *Mesh Status* again from there will return you to auto-refresh mode on the *Mesh Status* display.
|
||||
|
||||
- The **Cloud Mesh** button allows you to navigate to the *Mesh Status* display of the closest Supernode available to your device. Supernodes are a way to link multiple mesh island networks in a safe and efficient way. If your local node is part of a network with a Supernode, then you have the ability to view other nodes which are part of the Cloud Mesh network even if your local mesh is not otherwise linked to those networks. For further information see the *Supernode Architecture* description in the **Network Topologies** section of the **Network Design Guide**.
|
||||
|
||||
- The **Quit** button returns you to the *Node Status* display.
|
||||
|
||||
- The **Search** field allows you to filter the *Mesh Status* display by any keywords of your choice. The display will be limited to showing only nodes which match the keywords you enter. As you type each character from your keyboard into the search fields, the display will change to show only the entries that match your character or string. The filter is case insensitive, so it will find both upper and lower case entries for the characters you enter. If you press the **Refresh** button on the *Mesh Status* display, the search field will be cleared.
|
||||
|
||||
.. image:: _images/mesh-status.png
|
||||
:alt: Mesh Status
|
||||
.. image:: _images/mesh-status-columns.png
|
||||
:alt: Mesh Status display
|
||||
:align: center
|
||||
|
||||
|
|
||||
|
||||
Node Name
|
||||
^^^^^^^^^
|
||||
At the top of this page there is a search box which allows you to filter the mesh network display to include only those devices which match the keywords you enter. As you type each character from your keyboard into the search field, the display will change to show only the entries that match your character string. The filter is case insensitive, so it will find both uppercase and lowercase entries for the characters you enter. To restore the original display, delete your search characters or refresh the page in the web browser. To the right of the search field there is a ``Help`` button which explains the use of the **mesh status** page.
|
||||
|
||||
This shows your node as well as any connected LAN hosts and the advertised services available on your node and hosts. You can click any available web links to navigate to the services on your node or LAN hosts. This will be true for any available services in the *Current Neighbors* or *Remote Nodes* sections, too. Each node will be highlighted as you hover your cursor over it. This gives a visual indicator for any column entries that are part of the row over which you are hovering.
|
||||
The **mesh status** page is divided into several groups of devices, based on the link quality. The top groups are more likely to be reachable by your node than are the nodes in groups toward the bottom of the page.
|
||||
|
||||
If you have any hosts for which you selected *Do Not Propagate* in the **DHCP Reservations List**, those hosts will be displayed in a light gray color only on your node's *LAN Hostname* column. If you created any **DNS Aliases** for your hosts, those aliases will be displayed in a light orange color only on your node's *LAN Hostname* column. All other hosts will be displayed in the default color for the theme that you are using.
|
||||
Within each group the nodes are displayed side by side in two columns. The node in the upper left will have the best link quality, followed by the next best node to its right. Hovering the cursor over the left or right column will display a light gray background, making it easy to see which node you are focused on. You can navigate directly to that node by clicking on the node name.
|
||||
|
||||
Current Neighbors
|
||||
^^^^^^^^^^^^^^^^^
|
||||
Each node block will show the node name followed by a number that represents the :abbr:`ETX (Expected TX metric)`, which is an estimate of the number of :abbr:`OLSR (Optimized Link State Routing protocol)` packets that must be sent in order to receive a round trip acknowledgment, and it is often referred to as *link cost*. When sending data the :abbr:`OLSR (Optimized Link State Routing)` protocol selects the least cost route based on the lowest :abbr:`ETX (Expected TX metric)` in the direction of the final destination. Nodes are put into groups based on their :abbr:`ETX (Expected TX metric)`.
|
||||
|
||||
This shows a list of *Neighbor Nodes* that are linked with your node. These nodes may be connected via radio, Device-to-Device link (dtd), a cross-link (xlink) or a tunnel (tun) over an Internet connection. The display also shows any LAN hosts on your current neighbors as well as any advertised services available on those nodes and hosts.
|
||||
The display shows each node as well as any connected :abbr:`LAN (Local Area Network)` devices, as well as the advertised services available on the node and its hosts. You can click any available web links to navigate to the nodes or services listed.
|
||||
|
||||
Link Quality Statistics
|
||||
There are several link quality statistics displayed for each connected node.
|
||||
|
||||
- ``LQ`` or Link Quality is your node's view of the percent of `OLSR (Optimized Link State Routing protocol) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ packets received from the neighbor node. These packets exchange mesh routing and advertised services information, and they include a sequence number that is used to identify missing packets. For example, if 7 of 10 packets sent by the neighbor were received, then the probability for a successful packet transmission from this neighbor is 7/10 = 0.7 = 70%. Be aware that the *Quality* metric is calculated differently, so there may not be a perfect alignment when comparing the two quality metrics.
|
||||
|
||||
- ``NLQ`` or Neighbor Link Quality is the neighbor node's view of the percent of :abbr:`OLSR (Optimized Link State Routing protocol)` packets received from your node. This indicates the quality of the link from the neighbor's side.
|
||||
|
||||
- ``SNR`` or Signal-to-Noise Ratio is expressed in decibels (dB). It represents the level of signal which is detectable over the background noise floor, so a higher number is better. *SNR* is shown for both sides of any radio links (local SNR / remote SNR).
|
||||
|
||||
- ``Quality`` is the Link Quality calculated as the moving average of (total sent packets) divided by (total sent packets plus retransmissions), expressed as a percent. For example, if the node had to send every packet twice for it to be successfully received, the link quality would be 50%. An additional penalty is subtracted if the neighbor node is unpingable, which is explained in the *Advanced Configuration* section under "Ping Penalty". Be aware that the *LQ/NLQ* metrics are calculated differently, so there may not be a perfect alignment when comparing the two quality metrics.
|
||||
|
||||
- ``TxMbps`` or Transmit Megabits per Second is an estimate of the data rate achieved across any radio (RF) link with a neighbor node. This column may show zero if the data being transmitted between these nodes is not sufficient for the metric to be calculated.
|
||||
|
||||
- ``Distance`` is the calculated distance between your node and each remote node. This calculation is based on the GPS coordinates (Lat/Lon) that were entered on each node. If no GPS coordinates were entered, then the distance cannot be calculated and that metric will not be considered in the LQM improvement process.
|
||||
|
||||
- ``Service Name`` is the column which displays any available services on the neighbor node or its LAN hosts. You can click on service links to navigate to the webpage for those services.
|
||||
|
||||
In addition to the neighbor node name, there are text abbreviations in parentheses that tell how the neighbor node is connected and the status of the link.
|
||||
|
||||
Link Type
|
||||
- ``rf``: indicates a radio link to this node.
|
||||
- ``dtd``: indicates a *Device to Device* connection (typically using an Ethernet cable) to this node.
|
||||
- ``wg``: indicates a Wireguard tunnel link over the Internet.
|
||||
- ``tun``: indicates a legacy Internet tunnel link.
|
||||
- ``xlink``: indicates a connection between the nodes that traverses cross-linked devices.
|
||||
|
||||
Link Status
|
||||
- ``wan``: the node has been configured as a *Mesh Gateway*. Typically this is a gateway to the Internet, but it may also be to another isolated network.
|
||||
- ``active``: LQM determined that the link is viable and is being used.
|
||||
- ``pending``: LQM is collecting data and evaluating the link.
|
||||
- ``idle``: LQM has determined that the link is usable and would be ``active`` but the node routing table does not yet have a route for sending traffic across the link.
|
||||
- ``blocked``: LQM determined that the link is unusable and has blocked it from use.
|
||||
- ``blocked - distance``: LQM determined that the remote node is either too close or too distant, based on the Min and Max Distance settings described in the *Advanced Configuration* section.
|
||||
- ``blocked - signal``: LQM determined that the SNR on the link is too low to reliably pass data, based on the Min SNR setting described in the *Advanced Configuration* section.
|
||||
- ``blocked - retries``: LQM determined that the retransmission rate is too high to reliably pass data.
|
||||
- ``blocked - latency``: LQM determined that the link latency is too high to reliably pass data.
|
||||
- ``blocked - dtd``: LQM blocks the RF interface on any nodes to which a DtD link also exists.
|
||||
- ``blocked - dup``: LQM blocks a link in cases when your node has an RF link to other nodes which themselves connect to each other via DtD. This can occur when there are multiple radios at a site using the same channel. The best remote node is chosen as the RF link for your node but the other possible RF connections are blocked as duplicates.
|
||||
- ``blocked - user``: LQM will block any node which you enter in the *User Blocked Nodes* field described in the *Advanced Configuration* section.
|
||||
|
||||
You can refresh the *Link Status* values by pressing the *Refresh* button or by selecting the *Auto* button to automatically refresh the display. Links whose quality has improved may be activated, while links whose quality has worsened may be blocked.
|
||||
|
||||
Previous Neighbors
|
||||
If there were any Current Neighbors which disconnected within the last 24 hours they will be listed below any nodes that are currently connected. It shows the node name or IP address, as well as how long it has been since a node was actively connected to your node.
|
||||
|
||||
Remote Nodes
|
||||
^^^^^^^^^^^^
|
||||
|
||||
This section lists the other nodes on the network that are two or more hops away from your node. Advertised services on nodes and their LAN hosts are also listed. Remote Nodes are sorted by their ``ETX`` or *Expected Transmission* metric. :abbr:`ETX (Expected TX metric)` is an estimate of the number of :abbr:`OLSR (Optimized Link State Routing protocol)` packets that must be sent in order to receive a round trip acknowledgement, and it is often referred to as *link cost*. When sending data the :abbr:`OLSR (Optimized Link State Routing)` protocol selects the least cost route based on the lowest :abbr:`ETX (Expected TX metric)` in the direction of the final destination.
|
||||
|
||||
Link Status
|
||||
- ``wan`` indicates the node has been configured as a *Mesh Gateway*. Typically this is a gateway to the Internet, but it may also be to another isolated network.
|
||||
- ``(tun*?)`` indicates the node has tunnel links, with ``?`` indicating the number of tunnels on that node.
|
||||
.. |icon4| image:: _images/grid-custom.png
|
||||
:alt: Local mesh view
|
||||
|
|
181
arednGettingStarted/advanced_config.rst → arednGettingStarted/node_admin.rst
Executable file → Normal file
|
@ -1,43 +1,135 @@
|
|||
=======================
|
||||
Configuration Deep Dive
|
||||
=======================
|
||||
================
|
||||
Node Admin Guide
|
||||
================
|
||||
|
||||
During your node's *Basic Setup* you used the configuration display by clicking the **Setup** button and typing your username and password. The configuration area has many additional features which will be described in more detail below. Clicking **Node Status** exits configuration mode without saving any changes, returning you to the *Node Status* display.
|
||||
You must login as the node administrator in order to perform node management tasks.
|
||||
|
||||
.. image:: _images/admin-header.png
|
||||
:alt: Admin Navigation Controls
|
||||
:align: center
|
||||
|icon1| Click the user icon at the far right of the top nav bar. Select ``login`` and enter your node's admin password (which was configured when you installed the AREDN |trade| firmware).
|
||||
|
||||
There are several control buttons below the configuration links section.
|
||||
|icon2| Upon successful authentication you will see the admin icon, and the label to the right of your node name should say *admin*.
|
||||
|
||||
Help
|
||||
Opens a new window or tab to display the node help page.
|
||||
In *admin* mode the sections on the **node status** display become editable, and there is a new section of options that appears at the top of the center column. This document will start from the top and work down each column of settings, starting with the left column. When you hover the cursor over a section and a light gray background appears, this identifies that section as being configurable.
|
||||
|
||||
Save Changes
|
||||
Click this button to save any configuration changes you have made. Saving changes will first do a basic validation of the new settings, saving them to flash memory if no errors are found. The new settings take effect in about 20 seconds and a reboot may or may not be required.
|
||||
Node Name and Security
|
||||
----------------------
|
||||
|
||||
Reset Values
|
||||
Click this button to reload the currently saved settings from flash memory, effectively undoing any changes that were made.
|
||||
The name and security section allows you to configure the following settings. Context-sensitive help is available by clicking the ``Help`` button.
|
||||
|
||||
Default Values
|
||||
Click this button to reset your node's basic settings to the default values. This action does not affect your existing node name.
|
||||
|
||||
Reboot
|
||||
Click this button to force your node to reboot.
|
||||
|
||||
Basic Setup
|
||||
-----------
|
||||
|
||||
You have already configured many of the basic settings, but there are several additional features that will be explained below.
|
||||
|
||||
.. image:: _images/basic-setup.png
|
||||
:alt: Basic Setup Options
|
||||
:align: center
|
||||
.. image:: _images/admin-name-security.png
|
||||
:alt: Admin Name and Security
|
||||
:align: center
|
||||
|
||||
|
|
||||
|
||||
Mesh Column
|
||||
^^^^^^^^^^^^^^
|
||||
Node Name
|
||||
Begin the node name with your callsign, followed by unique identifying information of your choice. Node names may contain up to 63 letters, numbers, and dashes, but cannot begin or end with a dash. Underscores, spaces, or any other characters are not allowed. Node names are not case sensitive, but the case will be preserved on the node status display. Amateur radio operators are required to identify all transmitting stations. The AREDN |trade| node name is beaconed automatically by the node every five minutes, so the node name must contain your callsign. Recommended names follow the (callsign)-(label) format, such as AD5BC-MOBILE or AD5BC-120SE. As a general rule node names should be kept as short as possible, while clearly and uniquely identifying the node.
|
||||
|
||||
Description
|
||||
This is not a required field, but it is a good place to describe the features or function of this device. Many operators use this field to list their contact information or the tactical purpose for the node. There are no character restrictions in the field, but the maximum length allowed is 210 characters.
|
||||
|
||||
Password
|
||||
Typically passwords may contain the characters ``a-z``, ``A-Z``, ``0-9``, period ``.``, dash ``-``, underscore ``_``, exclamation ``!``, and tilde ``~``. Avoid Linux-reserved characters, including but not limited to ``#``, ``$``, ``&``, ``*``, ``<``, ``>``. Enter the new password again in the *Retype Password* box to verify it is correct. You can click the *eye* icon at the right of the password fields to toggle between hidden and visible text. Be sure to remember or record the new password so you can use it for any future administrative tasks on the node.
|
||||
|
||||
By clicking **Advanced Options** you can configure additional node security settings.
|
||||
|
||||
Upload SSH Key
|
||||
Uploading SSH keys allows computers to connect to the node via SSH without having to know the password. The SSH keys are generated on your computer using built-in utilities or the `PuTTY <https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html>`_ program's *Key Generator*. Once you have the key files on your computer, you can upload the *public* key to your AREDN |trade| node. Click the ``Browse`` button and locate the *public* key file, then click the ``Upload Key`` button at the lower right.
|
||||
|
||||
Remove SSH Key
|
||||
To remove an existing SSH key, click in the field at the right and select the key from the dropdown list. Then click the ``Remove Key`` button at the lower right.
|
||||
|
||||
When you are finished with your changes, you can click the ``Cancel`` button to ignore any changes you made. Click the ``Done`` button to continue with applying your changes. You will then be returned to your node's *admin* view where you will see a new item in the top nav bar.
|
||||
|
||||
.. image:: _images/admin-chg-pending.png
|
||||
:alt: Admin change pending
|
||||
:align: center
|
||||
|
||||
Click the ``Commit`` button to apply the change(s) or the ``Revert`` button to ignore any changes and revert to the previous settings.
|
||||
|
||||
Time Settings
|
||||
-------------
|
||||
|
||||
Select your timezone from the dropdown list, where the default value is `UTC (Coordinated Universal Time)`. You can also enter the hostname for a `NTP (Network Time Protocol)` source if your node is connected to a network which has a network time server. In the *NTP Server* field you should enter a valid hostname for the network time source, for example ``us.pool.ntp.org`` or ``AD5BC-ntp.local.mesh``. You may also choose how often NTP will update the node’s clock by selecting a value from the *NTP Updates* dropdown list. The default is once per day [daily] but you may also select once per hour [hourly].
|
||||
|
||||
.. image:: _images/admin-time.png
|
||||
:alt: Admin Time
|
||||
:align: center
|
||||
|
||||
Context-sensitive help is available by clicking the ``Help`` button. When you are finished with your changes, you can click the ``Cancel`` button to ignore any changes you made. Click the ``Done`` button to continue with applying your changes. You will then be returned to your node's *admin* view where you will be able to ``Commit`` or ``Revert`` your changes.
|
||||
|
||||
Firmware Settings
|
||||
-----------------
|
||||
|
||||
The top field displays the currently installed version of firmware on your node. There are three ways to update your node's firmware.
|
||||
|
||||
.. image:: _images/admin-firmware-1.png
|
||||
:alt: Admin Firmware
|
||||
:align: center
|
||||
|
||||
Download Firmware
|
||||
If your node has Internet access you can click the refresh icon on the right side of the field in order to update the list of available images. Select the image to download, click *Download*, and wait for the firmware to download and be installed.
|
||||
|
||||
#) **Upload Firmware**: If you have a new firmware image that you have already downloaded to your computer from the AREDN |trade| website, click the *Browse* button and select the firmware file from the location on your computer where you saved it. Click *Upload* and the file will be uploaded and installed on the node.
|
||||
|
||||
#)
|
||||
|
||||
#) **Load Local Firmware**: If you need to upgrade the firmware on a node which has a marginal connection to the network, the standard web/http method may not reliably transfer the image to the node. In this situation you may want to use an independent means of uploading the firmware to the node before beginning the upgrade process. Choose an upload method such as ``scp`` (secure copy) with a long connection timeout, which may allow the file transfer to continue the upload in the event of a network interruption. Transfer the new firmware file to your node, place it in the ``/tmp/web`` folder, and name it ``local_firmware.bin``. Refresh your node's *Administration* page and once the page detects the ``/tmp/web/local_firmware.bin`` file, then the *Apply Local Firmware* button will become active. Press this button to begin the update process using the firmware you previously uploaded.
|
||||
|
||||
Advanced Options
|
||||
++++++++++++++++
|
||||
|
||||
Keep Configuration
|
||||
This is enabled by default and it allows you to retain your existing configuration settings during the firmware upgrade process.
|
||||
|
||||
Firmware URL
|
||||
This is the source URL that is queried by the *Download Firmware* process in order to refresh the list of available firmware for your node.
|
||||
|
||||
|
||||
Package Settings
|
||||
----------------
|
||||
|
||||
|
||||
Network Settings
|
||||
----------------
|
||||
|
||||
|
||||
Location Settings
|
||||
-----------------
|
||||
|
||||
|
||||
Internal Services
|
||||
-----------------
|
||||
|
||||
|
||||
Local Services
|
||||
--------------
|
||||
|
||||
|
||||
Neighbor Devices
|
||||
----------------
|
||||
|
||||
|
||||
Radios and Antennas
|
||||
-------------------
|
||||
|
||||
|
||||
Mesh Memory Settings
|
||||
--------------------
|
||||
|
||||
|
||||
DHCP Settings
|
||||
-------------
|
||||
|
||||
|
||||
Tunnel Settings
|
||||
---------------
|
||||
|
||||
|
||||
Admin Tools
|
||||
-----------
|
||||
|
||||
|
||||
|
||||
|
||||
**Mesh** is the node's *radio* interface. The AREDN |trade| firmware has been designed to simplify the process of configuring networking interfaces. Network values are automatically calculated based on the unique :abbr:`MAC (Media Access Control)` addresses of your node. You may need to change the *Channel* and possibly the *Channel Width* parameters to match those of your local AREDN |trade| mesh, as explained previously in the **Basic Radio Setup** section. Normally you will not need to change the other network settings on this page, so keep these values unless you fully understand how the mesh works and why the defaults may not be suitable for your situation.
|
||||
|
||||
|
@ -133,18 +225,11 @@ WAN WiFi Client
|
|||
|
||||
The mesh node uses "WPA2 PSK" encryption to connect to the wifi AP. The password length must be between zero and 64 characters. If the key length is 64, it is treated as hex encoded. If the length is 0, then no encryption will be used to connect to an open AP. A single quote character must not be used in the passphrase.
|
||||
|
||||
To the right of the *WAN WiFi Client* label is an icon with hover text indicating the status of the WAN WiFi connection. |icon1| indicates no wifi connection to the local access point. |icon2| indicates a wifi connection but no Internet connection. |icon3| indicates both a wifi connection to the local access point and a connection to the Internet.
|
||||
To the right of the *WAN WiFi Client* label is an icon with hover text indicating the status of the WAN WiFi connection. indicates no wifi connection to the local access point. indicates a wifi connection but no Internet connection. indicates both a wifi connection to the local access point and a connection to the Internet.
|
||||
|
||||
After you *Save Changes* and reboot, the node will have Internet access via wifi rather than requiring a cable plugged into the node's WAN port. In fact, enabling the *WAN Wifi Client* will disable VLAN1, so Internet access will no longer be possible through the physical WAN port. Also, on the *Node Status* display you will see the **WiFi WAN Address** label and IP address to indicate that your WAN connection is using the WAN WiFi Client.
|
||||
|
||||
.. |icon1| image:: _images/wifi-noConn.png
|
||||
:alt: No WiFi onnection
|
||||
|
||||
.. |icon2| image:: _images/wifi-noInternet.png
|
||||
:alt: WiFi connection without Internet
|
||||
|
||||
.. |icon3| image:: _images/wifi-internet.png
|
||||
:alt: WiFi connection and Internet access
|
||||
|
||||
|
||||
Node VLANs
|
||||
|
@ -365,19 +450,6 @@ Administration
|
|||
Click the **Administration** link to navigate to these settings. There are four sections that provide ways for you to manage the firmware, packages, security keys, and support data on your node.
|
||||
|
||||
Firmware Update
|
||||
There are currently three ways to update the firmware on your node. No matter which method you choose, you can retain your existing configuration settings by selecting the *Keep Settings* checkbox.
|
||||
|
||||
.. image:: _images/admin-firmware.png
|
||||
:alt: Upgrade firmware
|
||||
:align: center
|
||||
|
||||
|
|
||||
|
||||
#) **Upload Firmware**: If you have a new firmware image that you have already downloaded to your computer from the AREDN |trade| website, click the *Browse* button and select the firmware file from the location on your computer where you saved it. Click *Upload* and the file will be uploaded and installed on the node.
|
||||
|
||||
#) **Download Firmware**: If your node has Internet access you can use the *Download Firmware* option. Click *Refresh* to update the list of available images. The source URLs that are queried are those listed on the *Advanced Configuration* page of your node. Select the image to download, click *Download*, and wait for the firmware to download and be installed.
|
||||
|
||||
#) **Load Local Firmware**: If you need to upgrade the firmware on a node which has a marginal connection to the network, the standard web/http method may not reliably transfer the image to the node. In this situation you may want to use an independent means of uploading the firmware to the node before beginning the upgrade process. Choose an upload method such as ``scp`` (secure copy) with a long connection timeout, which may allow the file transfer to continue the upload in the event of a network interruption. Transfer the new firmware file to your node, place it in the ``/tmp/web`` folder, and name it ``local_firmware.bin``. Refresh your node's *Administration* page and once the page detects the ``/tmp/web/local_firmware.bin`` file, then the *Apply Local Firmware* button will become active. Press this button to begin the update process using the firmware you previously uploaded.
|
||||
|
||||
Package Management
|
||||
Here you can install or remove software packages on the node. **Upload Package** allows you to install a package file by uploading it from your computer to your node. **Download Package** allows Internet-connected nodes to retrieve a package from the AREDN |trade| website. Clicking *Refresh* will update the list of packages available for download.
|
||||
|
@ -718,3 +790,10 @@ With the node powered on and fully booted:
|
|||
* **Hold for 15 seconds to return the node to “just-flashed” condition**
|
||||
|
||||
On some equipment models it may be possible to accomplish these reset procedures by pressing the *Reset* button on the PoE unit.
|
||||
|
||||
|
||||
.. |icon1| image:: _images/account-outline-custom.png
|
||||
:alt: Normal user view
|
||||
|
||||
.. |icon2| image:: _images/account-cog-outline-custom.png
|
||||
:alt: Admin user view
|
|
@ -2,11 +2,11 @@
|
|||
Node Status Display
|
||||
===================
|
||||
|
||||
Once you have completed the initial setup on your AREDN |trade| node, you can connect your computer to a :abbr:`LAN (Local Area Network)` port on the device or the :abbr:`PoE (Power over Ethernet)` and use a web browser to navigate to the node status page.
|
||||
Once you have completed the initial setup on your AREDN |trade| node, you can connect your computer to a :abbr:`LAN (Local Area Network)` port on the device or the :abbr:`PoE (Power over Ethernet)` and use a web browser to navigate to the **node status** page.
|
||||
``http://localnode.local.mesh`` or ``http://<your-nodename>.local.mesh``
|
||||
|
||||
.. image:: _images/node-status-columns.png
|
||||
:alt: Node Status display
|
||||
:alt: Node status display
|
||||
:align: center
|
||||
|
||||
This display has been designed to present all of the important information about your node in one place. Someone navigating to your node's status display will be able to see all of the key elements of interest without having to click to multiple pages. This display consists of a top bar, a left side bar, and three columns of information about your node.
|
||||
|
@ -25,7 +25,7 @@ Left Nav Bar
|
|||
|
||||
Using the icons on the left side bar you can navigate to various displays.
|
||||
|
||||
|icon3| navigates to this node status display.
|
||||
|icon3| navigates to this **node status** display.
|
||||
|
||||
|icon4| navigates to the local mesh status page showing the nodes visible on the local mesh network, as well as any services are provided by those nodes.
|
||||
|
||||
|
@ -42,7 +42,7 @@ Node Description
|
|||
This is not a required field, but it is a good place to describe the features or function of this device. Many operators use this field to list their contact information or the tactical purpose for the node. There are no character restrictions in the field, but the maximum length allowed is 210 characters.
|
||||
|
||||
Node Time, Uptime, Load Average, and Free Memory
|
||||
The node time is displayed, as well as the ``uptime``, which is the time since the last reboot. If an Internet connection or a local :abbr:`NTP (Network Time Protocol)` server is available, your node's NTP client will sync its time with that time source. The ``load`` is the average processor utilization for the last 1, 5, and 15 minutes. ``free flash`` and ``free ram`` shows how much storage space is remaining on your node. ``flash`` is the internal non-volatile storage where the operating system, configuration files, and software packages are kept. ``ram`` is the amount of :abbr:`RAM (Random Access Memory)` available for running processes on the node.
|
||||
The node time is displayed, as well as the ``uptime``, which is the time since the last reboot. If an Internet connection or a local :abbr:`NTP (Network Time Protocol)` server is available, your node's NTP client will sync its time with that time source. The ``load`` is the average system utilization for the last 1, 5, and 15 minutes. ``free flash`` and ``free ram`` shows how much storage space is remaining on your node. ``flash`` is the internal non-volatile storage where the operating system, configuration files, and software packages are kept. ``ram`` is the amount of :abbr:`RAM (Random Access Memory)` available for running processes on the node.
|
||||
|
||||
Firmware Information
|
||||
This displays the node's current firmware version. A badge on the right indicates the status of the firmware.
|
||||
|
@ -64,10 +64,24 @@ Local Services
|
|||
Local Devices
|
||||
This section displays any devices that are directly connected to your node. This includes devices that are connected to your node's :abbr:`LAN (Local Area Network)` via Ethernet cable (such as :abbr:`VoIP (Voice over IP)` phones, IP cameras, or service computers). If a device is reachable from your node, you can click on the device name link to navigate to that device.
|
||||
|
||||
.. note::
|
||||
? IS THIS IMPLEMENTED ? --- If you have any hosts for which you selected *Do Not Propagate* in the **DHCP Reservations List**, those hosts will be displayed in a light gray color only on your node's *LAN Hostname* column. If you created any **DNS Aliases** for your hosts, those aliases will be displayed in a light orange color only on your node's *LAN Hostname* column. All other hosts will be displayed in the default color for the theme that you are using.
|
||||
|
||||
If you hover the cursor over the device name, a popup will appear showing the relative link quality of the connection to that device. To the right of the device name there will be connectivity statistics, including :abbr:`lq (link quality)`, :abbr:`nlq (neighbor link quality)`, :abbr:`snr (signal to noise ratio)`, :abbr:`n snr (neighbor signal to noise ratio)`, :abbr:`errors (retransmission errors)`, :abbr:`mbps (kilobit/megabit per second throughput)`, and :abbr:`miles (distance from the device)`.
|
||||
|
||||
Neighbor Devices
|
||||
This section displays any nodes that are direct neighbors of your node, whether via :abbr:`RF (radio frequency)` (as indicated by the small radio signal icon to the right of the device name) or :abbr:`DtD (Device to Device)` nodes connected via Ethernet cable (as indicated by the small double arrow icon to the right of the device name). If a device is reachable from your node, you can click on the device name link to navigate to that device. If you hover the cursor over the device name, a popup will appear showing the relative link quality of the connection to that device. To the right of the device name there will be connectivity statistics, including :abbr:`lq (link quality)`, :abbr:`nlq (neighbor link quality)`, :abbr:`snr (signal to noise ratio)`, :abbr:`n snr (neighbor signal to noise ratio)`, :abbr:`errors (retransmission errors)`, :abbr:`mbps (kilobit/megabit per second throughput)`, and :abbr:`miles (distance from the device)`.
|
||||
This section displays any nodes that are direct neighbors of your node, whether via :abbr:`RF (radio frequency)` (as indicated by the small radio signal icon to the right of the device name), :abbr:`DtD (Device to Device)` nodes connected via Ethernet cable (as indicated by the small double arrow icon to the right of the device name), a cross-link, or a tunnel over an Internet connection. If a device is reachable from your node, you can click on the device name to navigate to that device. If you hover the cursor over the device name, a popup will appear showing the relative link quality of the connection to that device. To the right of the device name there will be connectivity statistics, including :abbr:`lq (link quality)`, :abbr:`nlq (neighbor link quality)`, :abbr:`snr (signal to noise ratio)`, :abbr:`n snr (neighbor signal to noise ratio)`, :abbr:`errors (retransmission errors)`, :abbr:`mbps (kilobit/megabit per second throughput)`, and :abbr:`miles (distance from the device)`.
|
||||
|
||||
Link Quality Statistics
|
||||
There are several link quality statistics displayed for each connected node.
|
||||
|
||||
- ``lq`` or Link Quality is your node's view of the percent of `OLSR (Optimized Link State Routing protocol) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ packets received from the neighbor node. These packets exchange mesh routing and advertised services information, and they include a sequence number that is used to identify missing packets. For example, if 7 of 10 packets sent by the neighbor were received, then the probability for a successful packet transmission from this neighbor is 7/10 = 0.7 = 70%. ``nlq`` or Neighbor Link Quality is the neighbor node's view of the percent of :abbr:`OLSR (Optimized Link State Routing protocol)` packets received from your node.
|
||||
|
||||
- ``snr`` or Signal-to-Noise Ratio is expressed in decibels (dB). It represents the level of signal which is detectable over the background noise floor, so a higher number is better. *SNR* is shown for both sides of any radio links (local ``snr`` and neighbor ``n snr``).
|
||||
|
||||
- ``errors`` represents the number of retransmission errors detected on the link.
|
||||
|
||||
- ``mbps`` is an estimate of the data rate achieved across any radio (RF) link. This column may show zero if the data being transmitted between these nodes is not sufficient for the metric to be calculated.
|
||||
|
||||
Right Column
|
||||
------------
|
||||
|
|
|
@ -7,13 +7,11 @@ If you experience issues with building or using AREDN |trade| devices, there are
|
|||
However, if you have issues that you think should be investigated by the AREDN |trade| development team, you can follow the steps below for engaging with the software developers.
|
||||
|
||||
Download a Support Data File
|
||||
Every node has a built-in tool that allows you to download a support data file containing information that is helpful for troubleshooting. To download a support data file from your node, navigate to the **Administration** page and scroll to the bottom. Click the *Download Support Data* link and your support file will be downloaded to your computer. If you are unable to navigate to the **Administration** page, you can simply enter this URL in your web browser to initiate the support data download:
|
||||
|
||||
| ``http://your-nodename-or-ip/cgi-bin/supporttool``
|
||||
|
||||
.. image:: _images/admin-support-data.png
|
||||
:alt: Administration - Support Data Download
|
||||
:align: center
|
||||
:align: right
|
||||
|
||||
Every node has a built-in tool that allows you to download a support data file containing information that is helpful for troubleshooting. To download a support data file from your node, login as your node administrator and click the tools icon in the left nav bar. In the list of available tools, click the *Support Data* link and your support file will be downloaded to your computer.
|
||||
|
||||
Create a GitHub account
|
||||
To open an issue on GitHub you first must create your own GitHub account. This is free and easy to do by following these steps:
|
||||
|
|
|
@ -41,7 +41,7 @@ If you would like to see the documentation for a specific AREDN |trade| release,
|
|||
arednGettingStarted/firstboot_setup
|
||||
arednGettingStarted/node_status
|
||||
arednGettingStarted/mesh_status
|
||||
arednGettingStarted/advanced_config
|
||||
arednGettingStarted/node_admin
|
||||
arednGettingStarted/report_issues
|
||||
|
||||
.. toctree::
|
||||
|
|