serval-dna/doc/README.md
Andrew Bettison e189bcf32a Add REST API technical document
Document some Keyring, Rhizome and MeshMS requests, many are still TBC.

Also fix doc/README.md's link to Cooee.md
2015-11-02 12:26:34 +10:30

2.5 KiB

Serval DNA Technical Documentation

Serval Project, May 2014

This directory contains technical documents that accompany the Serval DNA component of the Serval mesh network.

  • Building Serval DNA has instructions to build a native Serval DNA executable.

  • Testing Serval DNA describes the Serval DNA test scripts and the test framework.

  • Configuring Serval DNA describes the persistent configuration system and its command-line API, the built-in system file paths, daemon instances and basic network configuration.

  • MDP Packet Filtering describes the configuration options and rules file syntax for filtering incoming and outgoing MDP packets.

  • Tunnelling describes how to tunnel IP over the Serval mesh network.

  • Serval DNA on OpenWRT describes how to build and install Serval DNA packages for the OpenWRT platform.

  • Serval DNA OpenBTS support describes how Serval DNA has been integrated with the Commotion Wireless OpenBTS mobile telephony platform.

  • Mesh Datagram Protocol (MDP) describes the fundamental mesh protocol used in Serval Mesh networks and its C programming API.

  • Mesh Stream Protocol (MSP) describes a reliable message stream protocol used in Serval Mesh networks and its C programming API.

  • Serval DNA REST API describes the HTTP REST API that applications can use to access Serval's application-layer protocols such as Rhizome and MeshMS.

  • Cooee describes the protocol used for discovering services available on nearby (reachable) mesh network nodes.

  • Serval Infrastructure 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.
CC-BY-4.0 This document is available under the Creative Commons Attribution 4.0 International licence.