mirror of
https://github.com/servalproject/serval-dna.git
synced 2024-12-19 05:07:56 +00:00
71 lines
3.1 KiB
Markdown
71 lines
3.1 KiB
Markdown
Serval DNA Technical Documentation
|
|
----------------------------------
|
|
[Serval Project][], October 2016
|
|
|
|
This directory contains [technical documents][] that accompany the [Serval
|
|
DNA][] component of the [Serval mesh network][].
|
|
|
|
* [Building Serval DNA](../INSTALL.md) has instructions to build a native
|
|
Serval DNA executable.
|
|
|
|
* [Testing Serval DNA](./Testing.md) describes the Serval DNA test scripts and
|
|
the test framework.
|
|
|
|
* [Configuring Serval DNA](./Servald-Configuration.md) describes the
|
|
persistent configuration system and its command-line API, the built-in
|
|
system file paths, daemon instances and basic network configuration.
|
|
|
|
* [Notes for Developers](./Development.md) contains information of use to
|
|
developers of Serval DNA and to those experiencing build problems.
|
|
|
|
* [MDP Packet Filtering](./Mesh-Packet-Filtering.md) describes the
|
|
configuration options and rules file syntax for filtering incoming and
|
|
outgoing MDP packets.
|
|
|
|
* [Tunnelling](./Tunnelling.md) describes how to tunnel IP over the Serval
|
|
mesh network.
|
|
|
|
* [Serval DNA on OpenWRT](./OpenWRT.md) describes how to build and install
|
|
Serval DNA packages for the OpenWRT platform.
|
|
|
|
* [Serval DNA OpenBTS support](./OpenBTS.md) describes how Serval DNA has been
|
|
integrated with the Commotion Wireless OpenBTS mobile telephony platform.
|
|
|
|
* [Mesh Datagram Protocol (MDP)](./Mesh-Datagram-Protocol.md) describes the
|
|
fundamental mesh protocol used in Serval Mesh networks and its C programming
|
|
API.
|
|
|
|
* [Mesh Stream Protocol (MSP)](./Mesh-Stream-Protocol.md) describes a reliable
|
|
message stream protocol used in Serval Mesh networks and its C programming
|
|
API.
|
|
|
|
* [REST API](./REST-API.md) describes the common features of the various HTTP
|
|
REST APIs through which applications access the services of the Serval mesh
|
|
network, including:
|
|
* [Keyring REST API](./REST-API-Keyring.md) -- identity management
|
|
* [Rhizome REST API](./REST-API-Rhizome.md) -- decentralised content distribution
|
|
* [MeshMS REST API](./REST-API-MeshMS.md) -- secure, one-to-one messaging
|
|
|
|
* [CLI API](./CLI-API.md) describes the command-line interface used for
|
|
controlling the Serval DNA daemon and accessing its services.
|
|
|
|
* [Cooee](./Cooee.md) describes the protocol used for discovering services
|
|
available on nearby (reachable) mesh network nodes.
|
|
|
|
* [Serval Infrastructure](./Serval-Infrastructure.md) contains notes on plans
|
|
for how a Serval mesh network can use the Internet to increase its reach and
|
|
usefulness.
|
|
|
|
-----
|
|
**Copyright 2014 Serval Project Inc.**
|
|
**Copyright 2016 Flinders University**
|
|
|
|
This document is available under the [Creative Commons Attribution 4.0 International licence][CC BY 4.0].
|
|
|
|
|
|
[Serval Project]: http://www.servalproject.org/
|
|
[Serval DNA]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:servaldna:
|
|
[Serval mesh network]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:tech:mesh_network
|
|
[technical documents]: http://developer.servalproject.org/dokuwiki/doku.php?id=content:dev:techdoc
|
|
[CC BY 4.0]: ../LICENSE-DOCUMENTATION.md
|