https://github.com/vv9k/docker-api-rs

Rust interface to Docker containers
https://github.com/vv9k/docker-api-rs

Last synced: 6 days ago
JSON representation

Rust interface to Docker containers

• Host: GitHub
• URL: https://github.com/vv9k/docker-api-rs
• Owner: vv9k
• License: mit
• Created: 2021-04-09T06:03:44.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-24T14:19:58.000Z (6 months ago)
• Last Synced: 2024-10-10T19:17:46.609Z (about 1 month ago)
• Language: Rust
• Homepage:
• Size: 745 KB
• Stars: 104
• Watchers: 3
• Forks: 33
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docker-api

[![GitHub Actions](https://github.com/vv9k/docker-api-rs/workflows/Main/badge.svg)](https://github.com/vv9k/docker-api-rs/actions) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![Released API docs](https://docs.rs/docker-api/badge.svg)](http://docs.rs/docker-api)

> a rust interface to [Docker](https://www.docker.com/) containers

## Install

Add the following to your `Cargo.toml` file

```toml

[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:

```toml

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:

```toml

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

```

## Usage

Examples for most API endpoints can be found in the [examples directory](https://github.com/vv9k/docker-api-rs/tree/master/examples).

## Notice

This crate is a fork of [shiplift](https://github.com/softprops/shiplift).

## License

[MIT](https://raw.githubusercontent.com/vv9k/docker-api-rs/master/LICENSE)