mirror of https://github.com/aredn/aredn.git
add reg trademark to README (#592)
This commit is contained in:
Steve
GitHub
parent
6fba065d2d
commit
6edeb86688
138
README.md
138
README.md
|
|
@ -1,50 +1,24 @@
|
|||
# Amateur Radio Emergency Data Network AREDN(tm) Firmware
|
||||
# Amateur Radio Emergency Data Network AREDN® Firmware
|
||||
|
||||
http://www.arednmesh.org
|
||||
https://www.arednmesh.org
|
||||
|
||||
## About AREDN
|
||||
## About AREDN®
|
||||
|
||||
AREDN wireless networks are deployed by licensed Amateur Radio
|
||||
operators, Technician Class or higher, under FCC Part 97 allocations
|
||||
adjacent to FCC part 15, unlicensed, WIFI, allocations. They are
|
||||
configured as ad-hoc nodes to form mesh networks. The firmware
|
||||
created below enables the effective use of valuable and dedicated
|
||||
frequencies for communication services to government and private
|
||||
relief organizations in times of disaster or other emergencies.
|
||||
AREDN® wireless networks are deployed by licensed Amateur Radio operators, Technician Class or higher, under FCC Part 97 allocations adjacent to FCC part 15, unlicensed, WIFI, allocations. They are configured as adhoc nodes to form mesh networks. The firmware created below enables the effective use of valuable and dedicated frequencies for communication services to government and private relief organizations in times of disaster or other emergencies.
|
||||
|
||||
Amateur Radio frequencies are relatively clean of noise from the commercial
|
||||
allocations and ensure usability for Amateur Radio Operators. This firmware
|
||||
enables 802.11n wireless networks to be created and expanded with minimal
|
||||
to no pre-planning or IT expertise. A user can deploy a 'node' anywhere
|
||||
to connect in and extend an AREDN network. Device hardware options exist to
|
||||
provide sector coverage, build point-to-point links, and connect end
|
||||
point services to the network. High speed link rates are routinely achieved
|
||||
over long distances, e.g. 60Mbps+ on 10MHz channels over 80km links.
|
||||
This firmware enables 802.11 wireless networks to be created and expanded with little to no IT expertise. A user can deploy a 'node' anywhere to connect to and extend an AREDN® network. Device hardware options exist to provide sector coverage, build point-to-point links, and connect end point services to the network. High speed link rates are routinely achieved over long distances, e.g. 60Mbps+ on 10MHz channels over 80km links.
|
||||
|
||||
For further information on obtaining an Amateur Radio Technician Class
|
||||
license, please refer to http://www.arrl.org/getting-your-technician-license
|
||||
For further information on obtaining an Amateur Radio Technician Class license, please refer to https://www.arrl.org/getting-your-technician-license
|
||||
|
||||
## Usage Information
|
||||
|
||||
### What to know about the images built with the instructions below
|
||||
|
||||
This is the active 'main' branch with latest AREDN code.
|
||||
At anytime a new change may be broken or break prior capabilities.
|
||||
This is the active 'main' branch with latest AREDN® code. The Amateur Radio community is encouraged to participate in loading the images produced from a "nightly build" and run the AREDN® firmware in a variety of environments. Given new features may not yet be documented, participants should already have a basic knowledge of Linux and networking to understand and provide useful feedback to the Developer submitting the code.
|
||||
|
||||
The Amateur Radio community is encouraged to participate in loading the
|
||||
images produced from a "nightly build" and run the AREDN firmware in a
|
||||
variety of environments. Given new features may not yet be documented,
|
||||
participants should already have a basic knowledge of Linux and Networking to
|
||||
understand and provide useful feedback to the Developer submitting the
|
||||
code.
|
||||
The goal of participation is to obtain confidence that new features and the overall mesh node is stable. The more participation, the earlier an issue is found, the faster an enhancement will be turned into a release.
|
||||
|
||||
The goal of participation is to obtain confidence that new
|
||||
features and the overall mesh node is stable. The more participation,
|
||||
the earlier an issue is found, the faster an enhancement will be
|
||||
turned into a release.
|
||||
|
||||
Please refer to https://github.com/aredn/aredn/issues
|
||||
for a list of outstanding defects.
|
||||
Please refer to https://github.com/aredn/aredn/issues for a list of outstanding defects.
|
||||
|
||||
### Images built
|
||||
|
||||
|
|
@ -141,28 +115,19 @@ Meraki MR-16 | ath79 | - | 64MB | brick
|
|||
|
||||
The 'target' is a directory to find the image on at http://downloads.arednmesh.org
|
||||
|
||||
Latest Mikrotik installation options are found at: https://www.arednmesh.org/content/installation-instructions-mikrotik-devices
|
||||
Latest installation instructions are found at: https://docs.arednmesh.org/en/latest/
|
||||
|
||||
### Ethernet Port usage
|
||||
|
||||
The standard Ethernet port of an AREDN device uses the following vlan tags. An 802.1Q
|
||||
switch is necessary to utilize the vlan tagged networks:
|
||||
The standard Ethernet port of an AREDN® device uses the following vlan tags. An 802.1Q switch is necessary to utilize the vlan tagged networks:
|
||||
|
||||
* untagged: LAN devices - laptop, ipcam, voip phone, etc.
|
||||
* vlan 1: WAN - gateway to connect AREDN network to home network and/or internet (some devices support changing this vlan to an alternate value)
|
||||
* vlan 2: DtDLink (device to device) - AREDN network routing between nodes, typically cross band
|
||||
* vlan 1: WAN - gateway to connect AREDN® network to home network and/or internet (some devices support changing this vlan to an alternate value)
|
||||
* vlan 2: DtDLink (device to device) - AREDN® network routing between nodes, typically cross band
|
||||
|
||||
The following devices have enhanced Ethernet port usage. A single cat5 to the device
|
||||
could be plugged into ether the 'main' or 'secondary' port with standard port functionality.
|
||||
Both ports can be used interchangeably and simultaneously with LAN devices on both ports
|
||||
at the same time.
|
||||
The following devices have enhanced Ethernet port usage. A single cat5 to the device could be plugged into ether the 'main' or 'secondary' port with standard port functionality. Both ports can be used interchangeably and simultaneously with LAN devices on both ports at the same time.
|
||||
|
||||
If the device's hardware supports POE (Power Over Ethernet) pass-through from main port to secondary
|
||||
port, an Advanced Setting option will show to turn on/off. This is useful to power ipCams or other
|
||||
mesh nodes by daisy chaining the network cable from one device to another. Then only one network
|
||||
cable may be needed to reach 2 or 3 devices on the tower. Be sure to check the power capacity in the
|
||||
vendor specifications to not exceed. The first device in the chain will provide the DHCP address to
|
||||
all LAN devices on all nodes (because it powers up first).
|
||||
If the device's hardware supports POE (Power Over Ethernet) pass-through from main port to secondary port, an Advanced Setting option will show to turn on/off. This is useful to power ipCams or other mesh nodes by daisy chaining the network cable from one device to another. Then only one network cable may be needed to reach 2 or 3 devices on the tower. Be sure to check the power capacity in the vendor specifications to not exceed. The first device in the chain will provide the DHCP address to all LAN devices on all nodes (because it powers up first).
|
||||
|
||||
* NanoStation M2 XW
|
||||
* NanoStation M5 XW
|
||||
|
|
@ -187,8 +152,8 @@ The Mikrotik hAP AC Lite, Ubiquiti AirRouter, and AirRouter HP are pre-configure
|
|||
|
||||
The GL.iNet GL-AR150 and GL-AR300M16 are pre-configured with the following VLANS:
|
||||
|
||||
* Port labeled "WAN": untagged = AREDN WAN
|
||||
* Port labeled "LAN": untagged = AREDN LAN, vlan 2 = DtDLink (device to device)
|
||||
* Port labeled "WAN": untagged = AREDN® WAN
|
||||
* Port labeled "LAN": untagged = AREDN® LAN, vlan 2 = DtDLink (device to device)
|
||||
|
||||
The GL.iNet GL-AR750 is pre-configured with the following ports, left to right:
|
||||
|
||||
|
|
@ -196,16 +161,15 @@ The GL.iNet GL-AR750 is pre-configured with the following ports, left to right:
|
|||
* Middle Port with "<..>" icon: DtDLink (vlan 2)
|
||||
* Right Port with "<..>" icon: LAN (untagged)
|
||||
|
||||
IMPORTANT: For Gl.iNet devices, when initially installing AREDN on OpenWRT, you *MUST* uncheck the "Keep Settings" checkbox.
|
||||
|
||||
IMPORTANT: For Gl.iNet devices, when initially installing AREDN® on OpenWRT, you *MUST* uncheck the "Keep Settings" checkbox.
|
||||
|
||||
## Submitting Bug Reports
|
||||
|
||||
Please submit all issues to http://github.com/aredn/aredn/issues
|
||||
Please submit all issues to https://github.com/aredn/aredn/issues
|
||||
|
||||
## Developer Only Information
|
||||
|
||||
The AREDN firmware is based on OpenWrt with additional packages and patches.
|
||||
A Makefile automates the entire process to create firmware images.
|
||||
The AREDN® firmware is based on OpenWrt with additional packages and patches. A Makefile automates the entire process to create firmware images.
|
||||
|
||||
### Building with Docker
|
||||
Installing the Docker environment on your windows/linux/mac machine is a pre-requisite. A docker 'container' has been pre-configured with an aredn linux build environment. Alternative instructions are below if you wish to setup your linux install with the compiler pre-requisites necessary to do the build.
|
||||
|
|
@ -223,8 +187,7 @@ docker cp builder:/opt/aredn/aredn/firmware/targets/ath79/generic/<image>.bin <l
|
|||
|
||||
### Build Prerequisites
|
||||
|
||||
Please take a look at the [OpenWrt documentation](https://openwrt.org/docs/guide-developer/build-system/install-buildsystem)
|
||||
for a complete and up to date list of packages for your operating system.
|
||||
Please take a look at the [OpenWrt documentation](https://openwrt.org/docs/guide-developer/build-system/install-buildsystem) for a complete and up to date list of packages for your operating system.
|
||||
|
||||
On Ubuntu/Debian:
|
||||
```
|
||||
|
|
@ -264,88 +227,86 @@ make SUBTARGET=mikrotik
|
|||
make MAINTARGET=ath79
|
||||
```
|
||||
|
||||
Building the images may take minutes or hours depending on the machine.
|
||||
For more details see [build options](https://openwrt.org/docs/guide-developer/build-system/use-buildsystem).
|
||||
Review the build options in config.mk: `-j <nuMBer of cores + 1>`.
|
||||
Building the images may take minutes or hours depending on the machine. For more details see [build options](https://openwrt.org/docs/guide-developer/build-system/use-buildsystem).
|
||||
Review the build options in config.mk: `-j <nuMBer of cores + 1>`.
|
||||
`V=s` will give more verbose error messages.
|
||||
|
||||
An internet connection is required during the build process. A good internet
|
||||
connection can improve the build time.
|
||||
An internet connection is required during the build process. A good internet connection can improve the build time.
|
||||
|
||||
You need approximately 10GB of space for the build.
|
||||
|
||||
### How to build prior builds of AREDN
|
||||
### How to build prior builds of AREDN®
|
||||
|
||||
Prior AREDN images can be rebuilt. Replace one of the following after
|
||||
Prior AREDN® images can be rebuilt. Replace one of the following after
|
||||
the "cd aredn" command above:
|
||||
|
||||
AREDN release 3.22.12.0
|
||||
AREDN® release 3.22.12.0
|
||||
|
||||
```
|
||||
git checkout 3.22.12.0
|
||||
```
|
||||
|
||||
AREDN release 3.22.8.0
|
||||
AREDN® release 3.22.8.0
|
||||
|
||||
```
|
||||
git checkout 3.22.8.0
|
||||
```
|
||||
|
||||
AREDN release 3.22.6.0
|
||||
AREDN® release 3.22.6.0
|
||||
|
||||
```
|
||||
git checkout 3.22.6.0
|
||||
```
|
||||
|
||||
AREDN release 3.22.1.0
|
||||
AREDN® release 3.22.1.0
|
||||
|
||||
```
|
||||
git checkout 3.22.1.0
|
||||
```
|
||||
|
||||
AREDN release 3.21.4.0
|
||||
AREDN® release 3.21.4.0
|
||||
|
||||
```
|
||||
git checkout 3.21.4.0
|
||||
```
|
||||
|
||||
AREDN release 3.20.3.1
|
||||
AREDN® release 3.20.3.1
|
||||
|
||||
```
|
||||
git checkout 3.20.3.1
|
||||
```
|
||||
|
||||
AREDN release 3.20.3.0
|
||||
AREDN® release 3.20.3.0
|
||||
|
||||
```
|
||||
git checkout 3.20.3.0
|
||||
```
|
||||
|
||||
AREDN release 3.19.3.0
|
||||
AREDN® release 3.19.3.0
|
||||
|
||||
```
|
||||
git checkout 3.19.3.0
|
||||
```
|
||||
|
||||
AREDN release 3.18.9.0
|
||||
AREDN® release 3.18.9.0
|
||||
|
||||
```
|
||||
git checkout 3.18.9.0
|
||||
```
|
||||
|
||||
AREDN release 3.16.2.0
|
||||
AREDN® release 3.16.2.0
|
||||
|
||||
```
|
||||
git checkout 3.16.2.0
|
||||
```
|
||||
|
||||
AREDN release 3.16.1.1
|
||||
AREDN® release 3.16.1.1
|
||||
|
||||
```
|
||||
git checkout 3.16.1.1-make
|
||||
```
|
||||
|
||||
AREDN build 176
|
||||
AREDN® build 176
|
||||
|
||||
```
|
||||
git checkout 91ee867
|
||||
|
|
@ -364,9 +325,9 @@ Included in the git Repo:
|
|||
config.mk <- build settings
|
||||
openwrt.mk <- which openwrt repo and branch/tag/commit to use
|
||||
feeds.conf/ <- custom package feeds (edit to point to your clone of aredn_packages)
|
||||
files/ <- file system in AREDN created images, most customizations go here
|
||||
patches/ <- patches to openwrt go here
|
||||
scripts/ <- tests and other scripts called from the build
|
||||
files/ <- file system in AREDN® created images, most customizations go here
|
||||
patches/ <- patches to openwrt go here
|
||||
scripts/ <- tests and other scripts called from the build
|
||||
configs/ <- definitions of features in the devices' kernel and what packages to include
|
||||
Makefile <- the build definition
|
||||
README.md <- this file
|
||||
|
|
@ -379,12 +340,10 @@ results/ <- code checks and other test results in jUnit xml format
|
|||
|
||||
### Patches with quilt
|
||||
|
||||
The patches directory contains quilt patches applied on top of the
|
||||
openwrt git repo defined in config.mk.
|
||||
The patches directory contains quilt patches applied on top of the openwrt git repo defined in config.mk.
|
||||
|
||||
If a patch is not yet included upstream, it can be placed in the `patches` directory with
|
||||
the `quilt` tool. Please configure `quilt` as described in
|
||||
[OpenWrt Quilt](https://openwrt.org/docs/guide-developer/build-system/use-patches-with-buildsystem).
|
||||
the `quilt` tool. Please configure `quilt` as described in [OpenWrt Quilt](https://openwrt.org/docs/guide-developer/build-system/use-patches-with-buildsystem).
|
||||
|
||||
#### Add, modify or delete a patch
|
||||
|
||||
|
|
@ -405,13 +364,10 @@ quilt edit somedir/somefile2
|
|||
quilt refresh # creates/updates the patch file
|
||||
```
|
||||
|
||||
## Submitting new features and patches to AREDN
|
||||
## Submitting new features and patches to AREDN®
|
||||
|
||||
The high level steps to submit to this repository https://github.com/aredn/aredn are:
|
||||
|
||||
1) create a github account and 'fork' this repo
|
||||
2) git commit a change into your fork, e.g. http://github.com/ae6xe/aredn
|
||||
3) create a pull request for http://github.com/aredn/aredn to consider your change
|
||||
|
||||
|
||||
|
||||
2) git commit a change into your fork, e.g. https://github.com/ae6xe/aredn
|
||||
3) create a pull request for https://github.com/aredn/aredn to consider your change
|
||||
|
|
|
|||
Loading…
Reference in New Issue