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

Change TM to Registered Trademark symbol 

Change the TM symbol to the Registered Trademark symbol throughout the 
project. Also, add two descriptive paragraphs to the Tunnel section.
This commit is contained in:
Steve Lewis KC0EUW 2019-03-24 08:21:09 -07:00
parent e757563db0
commit 1e27cbf18e
28 changed files with 54 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
appendix/freq_charts.rst
View File

@ -23,5 +23,5 @@ The frequencies and channels that are available for AREDN |trade| networking are
:align: center
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

8
appendix/more_info.rst
View File

@ -8,10 +8,10 @@ Additional information about the AREDN |trade| project can be found at the links
* `AREDN forums <https://www.arednmesh.org/forum>`_
Contributing AREDN Documentation
--------------------------------
Contributing AREDN |trade| Documentation
----------------------------------------
If you are interested in contributing to the rapidly growing set of AREDN documentation you can easily do so on GitHub. To contribute to the AREDN project you first must create your own GitHub account. This is free and easy to do by following these steps:
If you are interested in contributing to the rapidly growing set of AREDN |trade| documentation you can easily do so on GitHub. To contribute to the AREDN |trade| project you first must create your own GitHub account. This is free and easy to do by following these steps:
1. Open your web browser and navigate to the `GitHub URL <https://github.com>`_.
2. Click the ``Sign Up`` button and enter a username, email, and password. We suggest using your callsign as the username.
@ -28,5 +28,5 @@ The only difference is the repository name of ``aredn/documentation`` and the ma
After you create a Pull Request on GitHub, the AREDN |trade| team will review your changes. Once your documentation contributions are committed to the AREDN |trade| GitHub repository, a webhook automatically updates and builds the latest docs for viewing and exporting on ReadTheDocs.org
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

10
arednGettingStarted/advanced_config.rst
View File

@ -148,7 +148,11 @@ See your node's **Help** file for additional insights on how this configuration
Tunnel Server
-------------
Click the **Tunnel Server** link to navigate to these settings. This section provides a way for you to configure your node with a special service that allows node-to-node connections across the Internet. Unless you have a specific need for this type of network connection, it is recommended that you do not install the *Tunnel Server* feature. This is because it will cause your node to dedicate limited system resources to running a service that may rarely or never be used. In order to increase the performance of your node you should conserve system resources so they will be available for normal node operations, which is especially important for nodes with limited memory and storage.
Click the **Tunnel Server** link to navigate to these settings. This section provides a way for you to configure your node with a special service that allows node-to-node connections across the Internet. Unless you have a specific need for this type of network connection, it is recommended that you do not install the *Tunnel Server* feature. This is because it will cause your node to dedicate limited system resources to running a service that may be used rarely. In order to increase the performance of your node you should conserve system resources so they will be available for normal node operations, which is especially important for nodes with limited memory and storage.
Tunnels should be used as a temporary means of connecting mesh islands when RF links have yet to be established. They should be removed as soon as RF links are operational. Remember that AREDN |trade| is first and foremost an emergency communication resource, so it's likely that Internet-dependent links and the assets they provide will not be available during a disaster. Their presence could create a false expectation for served agency personnel, so the network will fail to meet their expectations when tunneled resources become unavailable during a disaster.
Also, before using the AREDN |trade| tunnel feature, be aware of how this type of connection could impact your local mesh network. If your node participates in a local mesh via RF, then adding one or more tunnel connections on that node will cause the nodes and hosts on the far side of the tunnel(s) to appear on your local *Mesh Status* display. This adds complexity and makes everyone's display a little more difficult to navigate. If you want to participate in remote mesh networks via tunnel, consider establishing those tunnels from one of your nodes that is *not* connected to your local mesh network via RF.
Internet Connectivity Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -260,7 +264,7 @@ Specific values can be set for the following items. You may change these setting
Specifies the URL where the Leaflet Javascript file can be found.
*Firmware Download Path*
Specifies the URL from which AREDN firmware files can be downloaded.
Specifies the URL from which AREDN |trade| firmware files can be downloaded.
*PoE Passthrough*
Specifies whether Power over Ethernet should be enabled on nodes with ports that support PoE passthrough.
@ -281,5 +285,5 @@ With the node powered on and fully booted:
On some equipment models it may be possible to accomplish these reset procedures by pressing the *Reset* button on the PoE unit.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

8
arednGettingStarted/aredn_overview.rst
View File

@ -1,6 +1,6 @@
==============
AREDN Overview
==============
======================
AREDN |trade| Overview
======================
The AREDN |trade| acronym stands for "Amateur Radio Emergency Data Network" and it provides a way for *Amateur Radio* operators to create high-speed ad hoc *Data Networks* for use in *Emergency* and service-oriented communications.
@ -21,5 +21,5 @@ An AREDN |trade| network is able to serve as the transport mechanism for the pre
The primary goal of the AREDN |trade| project is to empower licensed amateur radio operators to quickly and easily deploy high-speed data networks when and where they might be needed, as a service both to the hobby and the community. This is especially important in cases when traditional "utility" services (electricity, phone lines, or Internet services) become unavailable. In those cases an off-grid amateur radio emergency data network may be a lifeline for communities impacted by a local disaster.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednGettingStarted/basic_setup.rst
View File

@ -59,5 +59,5 @@ In order to get your new AREDN |trade| node on the air, you need to enter the fo
Once you have entered, applied, and verified that your node settings are correct, click the **Save Changes** button. Your node will record the new configuration settings and automatically reboot.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

8
arednGettingStarted/downloading_firmware.rst
View File

@ -1,6 +1,6 @@
==========================
Downloading AREDN Firmware
==========================
==================================
Downloading AREDN |trade| Firmware
==================================
Once you have selected and obtained a device, the next step is to choose the matching AREDN |trade| firmware image for that specific device. The `AREDN download page <http://downloads.arednmesh.org/firmware/ubnt/html/stable.html>`_ displays the most current firmware releases for every supported device.
@ -14,5 +14,5 @@ There are two types of firmware images: one for the first-time replacement of th
Once you have selected the correct firmware image for your device, click the link to download the image file to your local computer. Make a note of the download location on your computer, since you will need to use that image to install the AREDN |trade| firmware on your device.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

12
arednGettingStarted/installing_firmware.rst
View File

@ -1,6 +1,6 @@
=========================
Installing AREDN Firmware
=========================
=================================
Installing AREDN |trade| Firmware
=================================
The steps for installing device firmware are documented on the AREDN |trade| website in the `Current Software <https://www.arednmesh.org/content/current-software>`_ section. Under the **Software** menu, select **Download** to reach the *Current Software* page.
@ -23,7 +23,7 @@ There are two cases for installing AREDN |trade| firmware:
Ubiquiti First Install Process
------------------------------
**Ubiquiti** devices have a built-in `TFTP <https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol>`_ server to which you can upload the AREDN *factory* image. Your computer must have TFTP client software available. Linux and Mac both have native TFTP clients, but you may need to enable or obtain a TFTP client for Windows computers. If you are using a Windows computer, `enable the TFTP client <https://www.trishtech.com/2014/10/enable-tftp-telnet-in-windows-10>`_ or download and install a `TFTP command line client <https://www.pcwdld.com/tftp-client-for-windows-7>`_.
**Ubiquiti** devices have a built-in `TFTP <https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol>`_ server to which you can upload the AREDN |trade| *factory* image. Your computer must have TFTP client software available. Linux and Mac both have native TFTP clients, but you may need to enable or obtain a TFTP client for Windows computers. If you are using a Windows computer, `enable the TFTP client <https://www.trishtech.com/2014/10/enable-tftp-telnet-in-windows-10>`_ or download and install a `TFTP command line client <https://www.pcwdld.com/tftp-client-for-windows-7>`_.
Download the appropriate *factory* file for your device by following the instructions in the **Downloading AREDN Firmware** section of this documentation.
@ -123,7 +123,7 @@ You will need `Tiny PXE <http://reboot.pro/files/file/303-tiny-pxe-server/>`_ so
Mikrotik First Install Process
------------------------------
**Mikrotik** devices must be flashed using steps that are similar to the alternate TP-LINK process described above. Your computer must run a TFTP/Bootp server in order to provide firmware images to Mikrotik nodes. Mikrotik nodes require a **two-part install** process: First, install and boot the *factory* (elf) file, and finally use the in-memory-only AREDN Administration UI to complete the installation of the *sysupgrade* (bin) file.
**Mikrotik** devices must be flashed using steps that are similar to the alternate TP-LINK process described above. Your computer must run a TFTP/Bootp server in order to provide firmware images to Mikrotik nodes. Mikrotik nodes require a **two-part install** process: First, install and boot the *factory* (elf) file, and finally use the in-memory-only AREDN |trade| Administration UI to complete the installation of the *sysupgrade* (bin) file.
**Preparation**
@ -180,5 +180,5 @@ Once your device is running AREDN |trade| firmware, you can display its web inte
By default AREDN |trade| devices run the :abbr:`DHCP (Dynamic Host Control Protocol)` service on their LAN interface, so your computer will receive an IP address from the node as soon as it is connected with an Ethernet cable. Ensure that your computer is set to obtain its IP address via :abbr:`DHCP (Dynamic Host Control Protocol)`.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednGettingStarted/mesh_status.rst
View File

@ -56,5 +56,5 @@ There are four sections on the **Mesh Status** display.
This section lists any nodes which were recently connected to your node but are not 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.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednGettingStarted/node_status.rst
View File

@ -81,5 +81,5 @@ If you click and drag your mouse across a region of the chart, the display will
On the left of the Realtime Graph there is an **SNR Sound** control. Clicking the *On* button will cause your computer to emit a tone that corresponds to the relative SNR level, with higher pitch tones indicating better SNR. This feature was added in order to provide an audio queue to operators in the process of aligning directional antennas. When your antenna reaches a position at which the highest pitch tone is heard you can lock it down without having to look at the signal graph display, knowing that you are receiving the best signal available. You can also adjust the tone pitch and volume with the sliders on the sound control.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

4
arednGettingStarted/selecting_devices.rst
View File

@ -17,8 +17,8 @@ One of the best sources of detailed device information is a manufacturer's datas
If you are just getting started with AREDN |trade| you can easily begin with one of the low-cost devices that comes with an integrated antenna and a :abbr:`PoE (Power over Ethernet)` unit. If you are expanding your AREDN |trade| network with more sophisticated equipment, you may choose a standalone radio attached to any of several kinds of high-gain antennas.
.. note:: See the **AREDN Network Design Guide** for more information about constructing robust mesh networks.
.. note:: See the **Network Design Guide** for more information about constructing robust mesh networks.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednHow-toGuides/firmware_upgrade.rst
View File

@ -11,5 +11,5 @@ Before starting the firmware upgrade, it may be necessary to stop, disable, or u
Use a stepped approach to firmware upgrades. For example, if your node is running version 3.16.1.0 you should probably upgrade to version 3.18.9.0 before attempting to apply a newer version.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednHow-toGuides/iperf.rst
View File

@ -25,5 +25,5 @@ Once the test has completed you will see the collected data summarized by time i
One of the many uses for IperfSpeed is to validate and optimize your node's *Distance* setting on the **Basic Setup** page. Try different *Distance* settings and note the network bandwidth using iperf, with the goal of choosing the *Distance* setting which yields the best network performance.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednHow-toGuides/puttygen_ssh_keys.rst
View File

@ -116,5 +116,5 @@ SAVE the session definition again.
:align: center
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednHow-toGuides/radio_mobile_settings.rst
View File

@ -50,5 +50,5 @@ The "T" in the 10th character position indicates the current MCS rate, and a "t"
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednNetworkDesign/channel_planning.rst
View File

@ -93,5 +93,5 @@ Based on the purpose for your network, try to create reliable paths to the locat
* Remember that a multi-hop path through the network must have good signal quality on each leg of the journey. You cannot expect adequate performance through a series of poor quality links. For example, if you traverse three links having :abbr:`LQ (Link Quality)` metrics of 65%, 45%, and 58%, your aggregate :abbr:`LQ (Link Quality)` will be 17% which is unusable. The aggregate :abbr:`LQ (Link Quality)` should be at least 50% to have a usable path.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednNetworkDesign/frequency_bands.rst
View File

@ -82,5 +82,5 @@ Some of the advantages and disadvantages of each frequency range are explained i
Different frequency ranges are available to connect the mesh nodes that are required in order to fulfill the purposes for your network. As you plan the frequencies to be deployed at specific locations, it may be helpful to use a *spectrum analyzer* for identifying ranges that are already in use. The ultimate goal is to have a reliable data network that accomplishes its purpose for providing services to the intended destinations and users.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednNetworkDesign/network_modeling.rst
View File

@ -65,5 +65,5 @@ An example *Radio Mobile* coverage plot is shown below. After entering the site,
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednNetworkDesign/network_topology.rst
View File

@ -31,5 +31,5 @@ A variety of factors could isolate groups of mesh nodes from each other. For exa
Different types of radio links may be needed to connect all of the mesh nodes that are required in order to fulfill the purposes for your network. The ultimate goal is to have a reliable data network that accomplishes its purpose for providing services to the intended destinations and users.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

4
arednNetworkDesign/networking_overview.rst
View File

@ -2,7 +2,7 @@
Networking Overview
===================
This **AREDN Network Design Guide** will discuss some of the useful principles for creating robust data networks as a service both to the amateur radio hobby and the community at large. An AREDN |trade| network is able to serve as the transport mechanism for the applications people rely upon to communicate with each other in the normal course of their business and social interactions, including email, chat, phone service, document sharing, video conferencing, and many other useful programs. Depending on the characteristics of the implementation, this digital data network can operate at near-Internet speeds with many miles between network nodes.
This **Network Design Guide** will discuss some of the useful principles for creating robust data networks as a service both to the amateur radio hobby and the community at large. An AREDN |trade| network is able to serve as the transport mechanism for the applications people rely upon to communicate with each other in the normal course of their business and social interactions, including email, chat, phone service, document sharing, video conferencing, and many other useful programs. Depending on the characteristics of the implementation, this digital data network can operate at near-Internet speeds with many miles between network nodes.
There are a variety of ways to interconnect AREDN |trade| nodes, but the most important question that should be answered is *"What is the purpose for this particular network?"* The specific requirements of your situation will drive the design of your data network. For example, consider the following issues.
@ -28,5 +28,5 @@ With these issues in mind, it is always best to keep your network as simple as p
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednServicesGuide/chat_programs.rst
View File

@ -95,5 +95,5 @@ Matrix distributed medium new linux/mac expert
=========== ============= ============ ==== =============== ======
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednServicesGuide/dispatch_programs.rst
View File

@ -65,5 +65,5 @@ OpenCAD open source small win/lin/mac/rpi medium
============ ============== =========== =============== ======
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednServicesGuide/email_programs.rst
View File

@ -66,5 +66,5 @@ Open Email client-server small lin/mac/rpi expert
WinLink email, attachments small win (proprietary) medium
========== ================== ============ ================= ======
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednServicesGuide/file_sharing.rst
View File

@ -46,5 +46,5 @@ One example package that facilitates collaborative document creation is `Etherpa
:align: center
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednServicesGuide/other_programs.rst
View File

@ -50,5 +50,5 @@ There may be situations when it would also be helpful to track the locations of
Depending on the requirements of your specific situation, almost any program that can operate across a peer-to-peer TCP/IP network could be deployed as a service on your mesh network. Check the `AREDN Forums <https://www.arednmesh.org/forum>`_ for additional information, ideas, and how-to posts about possible services for mesh networking.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednServicesGuide/services_overview.rst
View File

@ -41,5 +41,5 @@ There are also programs which have been designed to take advantage of multiple p
The remaining parts of this section focus on examples of services that could be offered on your AREDN |trade| network. Programs are grouped by type, and where possible the network impact of each program will be described in order for you to understand the resources that may be required to use the program as a service on the mesh.
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednServicesGuide/video_streaming.rst
View File

@ -105,5 +105,5 @@ Shinobi free for *NC* use medium lin/mac medium
*NC ~ non-commercial*
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

2
arednServicesGuide/voip_programs.rst
View File

@ -92,5 +92,5 @@ TeamTalk video conferencing large win/lin/mac/rpi easy
========== ================== ============ ================== ======
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:

10
index.rst
View File

@ -2,9 +2,9 @@
:alt: AREDN
:align: right
===================
AREDN Documentation
===================
===========================
AREDN |trade| Documentation
===========================
:Version: 3.19.3.0
@ -18,7 +18,7 @@ This documentation set consists of several sections which are shown in the navig
If you wish to locate specific topics within the documentation, you can type keywords into the *Search docs* field to display a list of items which match your search.
If you would like to see the documentation for a specific AREDN release, click on the **Read the Docs** label at the bottom of the navigation bar. This label shows the version you are currently viewing, but clicking the label bar opens a panel with several other options. Here you may choose to view another version of the documentation, and you can also download the entire documentation set in any of several formats *(PDF, ePub, HTML)* for offline use.
If you would like to see the documentation for a specific AREDN |trade| release, click on the **Read the Docs** label at the bottom of the navigation bar. This label shows the version you are currently viewing, but clicking the label bar opens a panel with several other options. Here you may choose to view another version of the documentation, and you can also download the entire documentation set in any of several formats *(PDF, ePub, HTML)* for offline use.
.. toctree::
:maxdepth: 1
@ -78,5 +78,5 @@ If you would like to see the documentation for a specific AREDN release, click o
appendix/more_info
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim: