git.iko.soy/docker-hs
on bug/listcontainers help sign in
docker-hs/README.md
48 lines 1.7 kB history raw
1# An API client for docker written in Haskell
3| Master |
4| -------|
5| [![master](https://travis-ci.org/denibertovic/docker-hs.svg?branch=master)](https://travis-ci.org/denibertovic/docker-hs) |
8## Current state
10Supported Docker Engine Api version: `v1.24` and onwards.
12Anything upward of that should work since Docker versions their API.
13Older docker version and engine api versions are not supported at the moment.
15## Documentation
17The API-documentation is available at
18[Hackage](https://hackage.haskell.org/package/docker). There are also some
19usage-examples in the main library source file,
20[`Client.hs`](https://hackage.haskell.org/package/docker/docs/Docker-Client.html).
22## Contributing
24Please see [CONTRIBUTING.md](CONTRIBUTING.md).
26### Project Setup
28For working on the library, you need the Haskell Tool Stack installed (see [the
29Haskell Tool Stack
30website](https://docs.haskellstack.org/en/stable/install_and_upgrade/)). You
31also need `make` to use the `Makefile` included in the project. Run `make help`
32to see the available commands (for building, running the tests and releasing).
34### Tests
36Tests are located in the `tests` directory and can be run with `make test`. This
37only runs the unit tests.
39To run integration tests, you need Docker installed and listening on Port `2375`
40of `localhost` (docker only listens to a Unix socket by default, see the [Docker
41documentation](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option)
42for details). Set the environment variable `RUN_INTEGRATION_TESTS`, i.e.
43`RUN_INTEGRATION_TESTS=1 make test`.
45## IRC
47If you have any questions or suggestions you can find the maintainers in `#docker-haskell`
48on freenode.