Mirrors
/
ARDEN-documentation
mirror of https://github.com/aredn/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #273 from hickey/group-aam 

Documentation for group alert messages
This commit is contained in:
Steve 2023-07-09 08:44:51 -07:00 committed by GitHub
parent d324eba068 d775e6149e
commit 78809326cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
arednGettingStarted/_images/advConfig-alerts.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 127 KiB

After

Width:  |  Height:  |  Size: 90 KiB

14
arednGettingStarted/advanced_config.rst
View File

@ -626,6 +626,20 @@ Alert Message Local URL
It is possible to include HTML tags in your message text, such as using the ``<br />`` tag to display subsequent text on the next line. However, it is best practice to keep alert messages short in order to minimize the height of the alert banner displayed on node webpages.
Alert Message Groups
In addition to local alert messages, it is possible to receive group alert messages. Group alert messages allow node operators to organize the mesh network into administrative/geographical domains or alert type by free form group names. Multiple group names can be added to this field as a comma seperated list. It is highly advisable that group name *not* contain spaces.
Group alerts should be considered by the network management team to create a consistant alert structure and types. The following are some examples to consider:
- Geographic regions (States, ARRL sections, large cities, etc.)
- Connection types (i.e. backbone, leaf nodes, tunnels)
- Infrastructure changes
- Weather alerts
- Wildfire, flooding, tsunami or volcano alerts
- SKYWARN activations / DHS threat level
The group alert messages are retrieved from the web server specified by the local URL setting. Similarly to how the local alert messages are created, the group alerts need to be stored in a file named after the group name in all lower case with a ``.txt`` extension.
Alert Message Pollrate
This field allows you to set the polling rate or interval in hours at which the node will check for message updates. The default polling rate is once every 12 hours, but you can make this value smaller if you want your node to check for updates more frequently.

2
arednGettingStarted/node_status.rst
View File

@ -154,7 +154,7 @@ Once the scan has finished, you can click the *Refresh* button to start a new sc
AREDN |trade| Alert Messages
----------------------------
The AREDN |trade| development team has the ability to post messages which Internet-connected nodes will automatically retrieve once every 12 hours by default. There are two types of messages: broadcast messages intended for all nodes, and directed messages which are only retrieved by individual nodes. Messages are displayed in a yellow banner on a node's webpages above the node name. Be aware that there is no guarantee of privacy for these messages, since anyone can view the message repository online.
The AREDN |trade| development team has the ability to post messages which Internet-connected nodes will automatically retrieve once every 12 hours by default. There are three types of messages: broadcast messages intended for all nodes, group messages selected by labels in advanced settings and directed messages which are only retrieved by individual nodes. Messages are displayed in a yellow banner on a node's webpages above the node name. Be aware that there is no guarantee of privacy for these messages, since anyone can view the message repository online.
.. image:: _images/aam-display.png
:alt: AAM Display