ExternalVendorCode/serval-dna
1
0
Fork 0
mirror of https://github.com/servalproject/serval-dna.git synced 2024-12-19 13:17:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
1e3236e89c
serval-dna/doc
History
Andrew Bettison 463e27684c Split REST API documentation into several files
2016-02-22 17:41:49 +10:30
..
cc-by-4.0.png Add CC-BY-4.0 license text 2014-05-19 17:28:42 +09:30
Cooee.md Document Cooee service discovery protocol 2014-05-30 17:08:22 +09:30
Development.md Fix OSX bugs in test framework 2016-01-27 00:24:43 +10:30
Mesh-Datagram-Protocol.md Add text of CC BY 4.0 license 2014-05-21 17:37:23 +09:30
Mesh-Packet-Filtering.md Add MDP packet filter rules documentation 2014-05-23 14:51:25 +09:30
Mesh-Stream-Protocol.md Add text of CC BY 4.0 license 2014-05-21 17:37:23 +09:30
OpenBTS.md Add text of CC BY 4.0 license 2014-05-21 17:37:23 +09:30
OpenWRT.md Fix broken link 2015-01-07 15:56:56 +01:00
README.md Split REST API documentation into several files 2016-02-22 17:41:49 +10:30
REST-API-Keyring.md Split REST API documentation into several files 2016-02-22 17:41:49 +10:30
REST-API-MeshMS.md Split REST API documentation into several files 2016-02-22 17:41:49 +10:30
REST-API-Rhizome.md Split REST API documentation into several files 2016-02-22 17:41:49 +10:30
REST-API.md Split REST API documentation into several files 2016-02-22 17:41:49 +10:30
Serval-Infrastructure.md Add text of CC BY 4.0 license 2014-05-21 17:37:23 +09:30
Servald-Configuration.md Minor improvements to README 2016-01-11 18:02:26 +10:30
Testing.md Fix coverage test documentation to reflect changes required to support clang 2014-06-16 16:11:11 +09:30
Tunnelling.md Add text of CC BY 4.0 license 2014-05-21 17:37:23 +09:30

README.md

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.

  • Notes for Developers contains information of use to developers of Serval DNA and to those experiencing build problems.

  • 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.

  • REST API describes the common features of the various HTTP REST APIs through which applications access the services of the Serval mesh network, including:

  • 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.