Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 1.58 KB

README.md

File metadata and controls

68 lines (47 loc) · 1.58 KB

docker-api

GitHub Actions MIT licensed Released API docs

a rust interface to Docker containers

Install

Add the following to your Cargo.toml file

[dependencies]
docker-api = "0.14"

Supported API

Default endpoints include:

  • Containers
  • Images
  • Networks
  • Volumes
  • Exec
  • System

To enable swarm endpoints add a swarm feature to Cargo.toml like so:

docker-api = { version = "0.14", features = ["swarm"] }

Swarm endpoints include:

  • Swarm
  • Nodes
  • Services
  • Tasks
  • Secrets
  • Configs
  • Plugins

Latest stable version of this crate supports API version: v1.42 Master branch supports: v1.43

Features

SSL Connection

To enable HTTPS connection to docker add a tls flag to Cargo.toml.

Chrono

To enable chrono DateTime timestamps add a chrono feature flag to Cargo.toml.

Default features

By default only chrono feature is enabled. To disable it use:

docker-api = { version = "0.14", default-features = false }

Usage

Examples for most API endpoints can be found in the examples directory.

Notice

This crate is a fork of shiplift.

License

MIT