README.md

Docker Client

This is a Docker Client written in Swift. It's using the NIO Framework to communicate with the Docker Engine via sockets.

Current Use Cases

• List of all images
• List of all containers
• Pull an image
• Create a new container from an image
• Start a container
• Get the stdOut and stdErr output of a container
• Get the docker version information
• Manage the container state
• Create and manage services
• Update services
• List services
• Clean the system (prune containers and images)

Installation

Package.swift

import PackageDescription

let package = Package(
    dependencies: [
    .package(url: "https://github.com/alexsteinerde/docker-client-swift.git", from: "0.1.0"),
    ],
    targets: [
    .target(name: "App", dependencies: ["DockerClient"]),
    ...
    ]
)

Xcode Project

To add DockerClientSwift to your existing Xcode project, select File -> Swift Packages -> Add Package Depedancy. Enter https://github.com/alexsteinerde/docker-client-swift.git for the URL.

Usage Example

let client = DockerClient()
let image = try client.images.pullImage(byIdentifier: "hello-world:latest").wait()
let container = try client.containers.createContainer(image: image).wait()
try container.start(on: client).wait()
let output = try container.logs(on: client).wait()
try client.syncShutdown()
print(output)

For further usage examples, please consider looking at the provided test cases. Or have a look at the demo projects in the next section. If you want to read more about this package, feel free to read my blog article about it.

Demo

There are two demo applications.

Project	Link
Mac App	https://github.com/alexsteinerde/docker-client-swift-mac-app
Vapor App	https://github.com/alexsteinerde/docker-client-vapor-demo

Security Advice

When using this in production, make sure you secure your application so no others can execute code. Otherwise, the attacker could access your Docker environment and so all of the containers running in it.

License

This project is released under the MIT license. See LICENSE for details.

Contribution

You can contribute to this project by submitting a detailed issue or by forking this project and sending a pull request. Contributions of any kind are very welcome :)