Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexsteinerde/docker-client-swift
This is a Docker Client written in Swift. It's using the NIO Framework to communicate with the Docker Engine via sockets.
https://github.com/alexsteinerde/docker-client-swift
docker-client swift swiftnio
Last synced: 3 months ago
JSON representation
This is a Docker Client written in Swift. It's using the NIO Framework to communicate with the Docker Engine via sockets.
- Host: GitHub
- URL: https://github.com/alexsteinerde/docker-client-swift
- Owner: alexsteinerde
- License: mit
- Created: 2021-02-08T19:26:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T06:32:37.000Z (over 1 year ago)
- Last Synced: 2024-07-05T13:46:18.806Z (4 months ago)
- Topics: docker-client, swift, swiftnio
- Language: Swift
- Homepage:
- Size: 43.9 KB
- Stars: 63
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Client
[](http://swift.org)
[](https://docs.docker.com/engine/api/v1.41/)
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
- [x] List of all images
- [x] List of all containers
- [x] Pull an image
- [x] Create a new container from an image
- [x] Start a container
- [x] Get the stdOut and stdErr output of a container
- [x] Get the docker version information
- [x] Manage the container state
- [x] Create and manage services
- [x] Update services
- [x] List services
- [x] Clean the system (prune containers and images)
## Installation
### Package.swift
```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
```swift
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](https://alexsteiner.de/blog/posts/docker-client-package-with-swift/) about it.
## Demo
There are two demo applications.
Project | Link
--- | ---
Mac App | [https://github.com/alexsteinerde/docker-client-swift-mac-app](https://github.com/alexsteinerde/docker-client-swift-mac-app)
Vapor App | [https://github.com/alexsteinerde/docker-client-vapor-demo](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](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 :)