package docker-api

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Compilation & installation
Documentation
Testing

docker-api
- CHANGES
- LICENSE
- README
- Library docker-api
  - Docker
    
    Stream
    
    Container
    
    Exec
    
    Image
- Sources
  - docker-api
    
    docker.ml
    
    docker__.ml
    
    docker_config.ml
    
    docker_utils.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

OCaml client for Docker Remote API

This library provides an OCaml client for Docker Remote API. This library is tested with the community edition of Docker.

Note that the OPAM and ocamlfind packages are called docker-api (to distinguish them from other packages related to Docker) but the OCaml module is named Docker (because the code reads better with that name IMHO).

Compilation & installation

The easier way to install this library is to use OPAM. Just type:

opam install docker-api

This library depends on Dune (to compile), uri, and yojson.

To compile as a developer, just type make and then make install to install it.

Documentation

Please read the interface or the HTML version.

Testing

If you compile using make, the tests will be built. In order to run them, make sure that the latest Debian image is installed — if not, simply issue docker pull debian:latest in a shell — and issue make test.