Commit Graph

55 Commits

Author SHA1 Message Date
Jeremy Lakeman
34b6ab6ec2 Update restful api docs 2017-05-30 09:27:48 +09:30
Andrew Bettison
a8e394d299 Add "keyring remove" command
Adds a CLI and RESTful API operation for "keyring remove", with simple
test cases.  Added the corresponding Java API operation.  Updated the
API documentation.

API change: for consistency with RESTful API design, the GET
/restful/keyring/add operation now returns "201 Created" not "200 OK" if
successful.
2016-11-07 13:07:49 +10:30
Andrew Bettison
192fefd7f2 Update INSTALL.md to describe built artifacts 2016-10-19 09:47:48 +10:30
Andrew Bettison
4b2060554e Rename configure.in to configure.ac 2016-10-13 16:05:58 +10:30
Andrew Bettison
0bf7c5ccea Update copyright messages in documentation 2016-09-21 18:31:31 +09:30
Andrew Bettison
7e39698234 Improve libsodium dev documentation 2016-09-21 18:15:34 +09:30
Andrew Bettison
11b091a33b Update doco for OS-X installation and development 2016-09-12 15:09:46 +09:30
Andrew Bettison
c45e92b731 Fix OS-X build with libsodium
Add a new 'build-libsodium.sh' script and instructions in
doc/Development.md.  Update the configure.in script to check for
libsodium headers and library, and print helpful messages if not
present.
2016-09-12 15:09:41 +09:30
Andrew Bettison
c3a94a7ac3 Formalise dependency on libsodium
./configure now fails if libsodium is not present.
Added libsodium to the list of dependencies in INSTALL.md.
Add a Debian apt-get command to doc/Development.md.
2016-09-05 17:04:22 +09:30
Andrew Bettison
463e27684c Split REST API documentation into several files 2016-02-22 17:41:49 +10:30
Andrew Bettison
0361b99ca7 Fix OSX bugs in test framework
Use GNU grep, sed and awk instead of BSD variants.  Developers will have
to install these using a package manager like homebrew.  Updated the
INSTALL.md and doc/Development.md tech docs with instructions.
2016-01-27 00:24:43 +10:30
Andrew Bettison
bc1203c87c Minor improvements to README 2016-01-11 18:02:26 +10:30
Andrew Bettison
e51189a1c8 Remove aclocal.m4 from version control
Henceforward, aclocal.m4 will be generated by the 'autoreconf' command.

The 'autoreconf -f -i' command may now emit a warning "Unsupported
attribute section, the test may fail" on some systems, but it will still
generate the proper aclocal.m4 and ./configure files.  To suppress this
warning, simply invoke autoreconf with '-I m4' argument:

    autoreconf -f -i -I m4

The INSTALL.md has been updated accordingly, and a new 'Notes for
Developers' technical document added, explaining the use of aclocal and
autoreconf, and documenting that these warning messages are of no
concern.
2016-01-11 18:02:26 +10:30
Andrew Bettison
bd45186a6a Document REST POST /restful/rhizome/insert
Adds definitions for Rhizome concepts such as Bundle ID, Bundle Secret,
payload, etc. and a detailed step-by-step definition of the insertion
logic.
2015-12-07 22:39:19 +10:30
Andrew Bettison
3c993f0273 Add fromhere=2 to Rhizome list output
Need a way for the client to distinguish between authenticated (certain)
and unauthenticated (likely) author SIDs in the context of a bundle list,
since the bundle list does not verify manifest signatures for performance
and battery life reasons.
2015-11-02 12:26:40 +10:30
Andrew Bettison
419364b5a9 Improve REST HTTP response status codes
List all the HTTP status codes in the REST API tech doc.

Only use 403 Forbidden for requests originating from a disallowed
origin (ie, not localhost).

- Return 400 for missing, unknown, duplicate and out-of-order form
  parts in POST requests.
- Return 415 Unsupported Media Type for unsupported form part
  Content-Disposition and Content-Type (including unsupported
  charset).
- Return 414 Request-URI Too Long for any buffer exhaustion while
  parsing request.
- Return 419 Authentication Timeout for missing crypto secret.
2015-11-02 12:26:40 +10:30
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
Andrew Bettison
f36aac529e Fix broken link 2015-01-07 15:56:56 +01:00
Jeremy Lakeman
e375e17faa Fix coverage test documentation to reflect changes required to support clang 2014-06-16 16:11:11 +09:30
Andrew Bettison
3d537f9645 Improve test framework: test coverage support 2014-06-06 14:47:54 +09:30
Andrew Bettison
d811978220 Document Cooee service discovery protocol 2014-05-30 17:08:22 +09:30
Andrew Bettison
be4f7ad42d Add MDP packet filter rules documentation 2014-05-23 14:51:25 +09:30
Andrew Bettison
24f3d50fd4 Add text of CC BY 4.0 license
Add LICENSE-DOCUMENTATION.md (commons deed) and CC-BY-4.0.md (legal
text)

All docs link to local commons deed instead of CC BY 4.0 web page
2014-05-21 17:37:23 +09:30
Jeremy Lakeman
c0c5412931 Add support for STOPping a connection before shutdown 2014-05-21 17:17:07 +09:30
Andrew Bettison
2681967681 Add doc/README.md 2014-05-20 14:54:24 +09:30
Andrew Bettison
1e6caa0e6c Add Tunnelling document (TCP over MSP) 2014-05-19 17:29:10 +09:30
Andrew Bettison
59b3015ae8 Add CC-BY-4.0 license text 2014-05-19 17:28:42 +09:30
Andrew Bettison
42d4ed0d43 Improve MSP documentation
Rename "Mesh Streaming Protocol" to "Mesh Stream Protocol"
2014-05-19 17:26:54 +09:30
Andrew Bettison
48ae5688bf Start MDP documentation, improve MSP documentation 2014-05-16 12:50:15 +09:30
Andrew Bettison
5463feeff7 Improve MSP API documentation 2014-05-15 16:28:06 +09:30
gardners
1dc09f513c Document MSP API 2014-04-11 11:24:50 +09:30
Andrew Bettison
938d645dbd Create skeleton MSP tech document 2014-04-07 12:12:53 +09:30
Andrew Bettison
53c1b1c04c Filesystem Heirarchy Standard (FHS) paths
If no instance directory specified, then use paths like
/etc/serval/serval.conf
/var/cache/serval
/var/log/serval
/var/run/serval
etc. for files, instead of all in a single directory.

Log all directory creation as INFO messages.

Interpretation of log.file.directory_path has changed slightly.

Updated servald configuration tech doc.
2014-03-26 15:35:43 +10:30
Andrew Bettison
b066aafe62 Fix broken link 2014-03-05 19:54:10 +10:30
Andrew Bettison
d8ba926492 Fix broken links and formatting 2014-03-05 19:51:23 +10:30
Andrew Bettison
734368608e Update README, INSTALL and OpenWRT instructions
Instructions for releasing Serval DNA for OpenWRT
2014-03-05 15:26:28 +10:30
Andrew Bettison
319031b79d OpenWRT build instructions 2014-03-03 15:21:53 +10:30
Andrew Bettison
e10c4d92a1 Replace ./configure --enable-instance-path=<path> with INSTANCE_PATH=<path> 2014-03-03 15:16:53 +10:30
Andrew Bettison
d15c336c10 Minimal doc/OpenBTS.md points to app_servaldna repo 2013-05-30 15:52:37 +09:30
Andrew Bettison
cbcb4d1ab4 Rename OpenBts-setup.md to OpenBTS.md 2013-05-30 15:52:37 +09:30
Andrew Bettison
43af757262 Incorporate material from serval-dna/doc/OpenBts-setup.md 2013-05-29 15:28:05 +09:30
Andrew Bettison
b4100590f6 Improve configuration documentation 2013-05-29 10:52:35 +09:30
Andrew Bettison
e66c39a213 Improve config documentation 2013-04-16 12:44:47 +09:30
Andrew Bettison
f72e64fead Minor improvements to config doco 2013-04-15 19:20:35 +09:30
Andrew Bettison
534bf7a1a2 Improve network interface configuration doco 2013-04-15 18:59:49 +09:30
Andrew Bettison
64699101b0 Update Servald network interfaces documentation 2013-04-15 16:30:45 +09:30
Andrew Bettison
521e04a1c6 Update configuration and logging instructions 2013-04-12 17:18:53 +09:30
Andrew Bettison
74adb2038a Document 'config dump' command
Re-order the documentation sections and add more explanation
of how an invalid config file is handled.
2013-03-20 20:44:12 -07:00
Andrew Bettison
c9f9ef5ed4 New config type: bool_t (char)
Replace 'int_boolean' and 'char_boolean' representations with 'boolean'.

Clean up spacing and column alignment in conf_schema.h
2013-03-05 12:35:30 +10:30
Andrew Bettison
11c6c149a4 Fix a few mistakes in config documentation 2012-12-12 23:17:04 -08:00