Infotrope ACAP Server Documentation

Hi. Welcome to the documentation, such as it is.

Please read it carefully, and test the results carefully - I really can't promise that there aren't bugs in the documentation, or the server. I can't, I'm afraid, test everything.

There are gaping holes and missing pages in this documentation. Feel absolutely, 100%, totally free to email me and ask questions. (Or the list, at infotrope@clues.ltd.uk).

Contents

Building, Compiling, etc

Hopefully describes how to get an installed executable from the funny text stuff in the tarball.

Bootstrapping

One of the aesthetic problems of writing a configuration server - where do you stick the configuration? In itself, of course. Which does make life very interesting when you're starting it up for the first time.

Configuration

Once the ACAP server is running, you'll need to configure it a bit. This includes configuring it to listen on the standard ACAP port. Some SASL (Authentication) configuration is discussed here, along with pointers to more.

History

A brief history of why I've written the server at all, and why it's written the way it is.

Development Documentation

I've tried to write down what I'm doing, and in some cases, why. Hopefully this should explain it all.

Server Structure

Two processes, one single thread and tightly coded, one large multithread and defensively coded. This document explains what they do.

Control Protocol

That process called acapd doesn't speak ACAP at all - that would increase its complexity too high for me to consider it safe to run as root, realistically. Instead it runs a very simple control protocol.

Commands, and how to write them

A technical overview of commands.


Dave Cridland
Last modified: Tue Nov 30 10:31:03 GMT 2004