OpenCache Documentation

OpenCache consists of a number of unique elements, each of which has its own documentation. This is hosted at the excellent Read the Docs.

Controller

OpenCache operates in a controller-node architecture, where a single controller is responsible for a number of nodes. The controller is used as a focal point for command and control operations, including exposing a powerful API. Detailed documentation on the controller and external API can be found at: opencache-controller.rtfd.org.

Node

A node directly serves content in response to a user request. It also regulararly communicates with the controller using an internal API to relay statistics and state. Node documentation can be found at: opencache-node.rtfd.org.

Console

A user can interact with an OpenCache deployment using the console; a graphical user interface. This also provides live graphing and monitoring functionality. More details can be found at: opencache-console.rtfd.org.

Vagrant

To get started with OpenCache, a Mininet-based virtual machine is provided. For more information, please see: opencache-vagrant.rtfd.org.