third_party/ot-br-posix/repo/README.md

   1 [![Build Status][ot-gh-action-build-svg]][ot-gh-action-build] [![Docker Status][ot-gh-action-docker-svg]][ot-gh-action-docker] [![Build Status][otbr-travis-svg]][otbr-travis] [![Coverage Status][otbr-codecov-svg]][otbr-codecov]
   2
   3 ---
   4
   5 # OpenThread Border Router
   6
   7 Per the [Thread 1.1.1 Specification](http://threadgroup.org/ThreadSpec), a Thread Border Router connects a Thread network to other IP-based networks, such as Wi-Fi or Ethernet. A Thread network requires a Border Router to connect to other networks.
   8
   9 A Thread Border Router minimally supports the following functions:
  10
  11 - End-to-end IP connectivity via routing between Thread devices and other external IP networks
  12 - External Thread Commissioning (for example, a mobile phone) to authenticate and join a Thread device to a Thread network
  13
  14 <a href="https://www.threadgroup.org/What-is-Thread#certifiedproducts">
  15 <img src="/doc/images/certified.svg" alt="Thread Certified Component" width="150px" align="right">
  16 </a>
  17
  18 OpenThread's implementation of a Border Router is called OpenThread Border Router (OTBR). **OTBR is a Thread Certified Component** on the Raspberry Pi 3B with a Nordic nRF52840 NCP.
  19
  20 OTBR includes a number of features, including:
  21
  22 - Web UI for configuration and management
  23 - Thread Border Agent to support an External Commissioner
  24 - DHCPv6 Prefix Delegation to obtain IPv6 prefixes for a Thread network
  25 - NAT64 for connecting to IPv4 networks
  26 - DNS64 to allow Thread devices to initiate communications by name to an IPv4-only server
  27 - Docker support
  28
  29 More information about Thread can be found at [threadgroup.org](http://threadgroup.org/). Thread is a registered trademark of the Thread Group, Inc.
  30
  31 [ot-gh-action-build]: https://github.com/openthread/ot-br-posix/actions?query=workflow%3ABuild+branch%3Amaster+event%3Apush
  32 [ot-gh-action-build-svg]: https://github.com/openthread/ot-br-posix/workflows/Build/badge.svg?branch=master&event=push
  33 [ot-gh-action-docker]: https://github.com/openthread/ot-br-posix/actions?query=workflow%3ADocker+branch%3Amaster+event%3Apush
  34 [ot-gh-action-docker-svg]: https://github.com/openthread/ot-br-posix/workflows/Docker/badge.svg?branch=master&event=push
  35 [otbr-travis]: https://travis-ci.org/openthread/ot-br-posix
  36 [otbr-travis-svg]: https://travis-ci.org/openthread/ot-br-posix.svg?branch=master
  37 [otbr-codecov]: https://codecov.io/gh/openthread/ot-br-posix
  38 [otbr-codecov-svg]: https://codecov.io/gh/openthread/ot-br-posix/branch/master/graph/badge.svg
  39
  40 ## Getting started
  41
  42 The quickest way to get started with OTBR is to try the Docker version. Run OTBR in a Docker container on any Linux-based system or a Raspberry Pi 3B, using either a physical or emulated NCP. See the [Docker Support guide on openthread.io](https://openthread.io/guides/border-router/docker) for more info.
  43
  44 OTBR also runs directly on supported platforms like the Raspberry Pi 3B. If you're interested in building and configuring OTBR directly, or to learn more about the OTBR architecture, then see the rest of our end-user documentation at [openthread.io](https://openthread.io/guides/border_router).
  45
  46 > Note: For users in China, end-user documentation is available at [openthread.google.cn](https://openthread.google.cn/guides/border-router).
  47
  48 If you're interested in contributing to OpenThread Border Router, read on.
  49
  50 # Contributing
  51
  52 We would love for you to contribute to OpenThread Border Router and help make it even better than it is today! See our [Contributing Guidelines](https://github.com/openthread/ot-br-posix/blob/master/CONTRIBUTING.md) for more information.
  53
  54 Contributors are required to abide by our [Code of Conduct](https://github.com/openthread/ot-br-posix/blob/master/CODE_OF_CONDUCT.md) and [Coding Conventions and Style Guide](https://github.com/openthread/ot-br-posix/blob/master/STYLE_GUIDE.md).
  55
  56 We follow the philosophy of [Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all).
  57
  58 # Versioning
  59
  60 OpenThread Border Router follows the [Semantic Versioning guidelines](http://semver.org/) for release cycle transparency and to maintain backwards compatibility. OpenThread Border Router's versioning is independent of the Thread protocol specification version but will clearly indicate which version of the specification it currently supports.
  61
  62 # License
  63
  64 OpenThread Border Router is released under the [BSD 3-Clause license](https://github.com/openthread/ot-br-posix/blob/master/LICENSE). See the [`LICENSE`](https://github.com/openthread/ot-br-posix/blob/master/LICENSE) file for more information.
  65
  66 Please only use the OpenThread name and marks when accurately referencing this software distribution. Do not use the marks in a way that suggests you are endorsed by or otherwise affiliated with Nest, Google, or The Thread Group.
  67
  68 # Need help?
  69
  70 There are numerous avenues for OpenThread support:
  71
  72 - Bugs and feature requests — [submit to the Issue Tracker](https://github.com/openthread/ot-br-posix/issues)
  73 - Stack Overflow — [post questions using the `openthread` tag](http://stackoverflow.com/questions/tagged/openthread)
  74 - Google Groups — [discussion and announcements at openthread-users](https://groups.google.com/forum/#!forum/openthread-users)
  75
  76 The openthread-users Google Group is the recommended place for users to discuss OpenThread and interact directly with the OpenThread team.
  77
  78 ## OpenThread
  79
  80 To learn more about OpenThread, see the [OpenThread repository](https://github.com/openthread/openthread).