ilyakooo0/docker-hs
1
0
Fork 0
mirror of https://github.com/ilyakooo0/docker-hs.git synced 2024-09-11 10:35:29 +03:00
Code Issues Projects Releases Wiki Activity
A Haskell library for the Docker Engine API
273 Commits 5 Branches 14 Tags 446 KiB
Haskell 98.4%
Makefile 1%
Shell 0.6%
051e5f5a9e
Go to file
Deni Bertovic 051e5f5a9e Merge branch 'pr48'
2018-01-09 00:51:00 +01:00
examples Updates docs and examples 2017-03-20 11:05:11 +01:00
scripts Adds script for building docs. 2016-09-07 16:45:15 +02:00
src/Docker Merge branch 'pr48' 2018-01-09 00:51:00 +01:00
tests Merge branch 'pr48' 2018-01-09 00:51:00 +01:00
.gitignore Gitignore 2017-03-21 00:04:52 +01:00
.travis.yml we don't support docker versions earlier than 1.12 since bumping the api 2018-01-07 01:14:27 -05:00
CHANGELOG.md Adds changelog entry 2017-10-16 15:31:03 +02:00
CONTRIBUTING.md added contribution guidelines to CONTRIBUTING.md 2017-10-18 09:31:16 +02:00
docker.cabal Adds integration test 2017-11-01 12:29:05 +01:00
LICENSE Makes licence year the year of release 2017-10-10 16:37:23 +02:00
Makefile WIP fixed listing containers 2017-12-14 16:34:03 +01:00
README.md Merge pull request #42 from SKoschnicke/master 2017-11-01 11:26:07 +01:00
Setup.hs initial commit 2014-09-19 19:52:30 +02:00
stack-7.10.yaml Removes duplicate extra-deps 2017-03-24 12:36:36 +01:00
stack-8.0.2.yaml Update dependencies to work with the stack lts-9 resolver 2017-09-20 00:19:56 -04:00
stack-8.0.yaml Adds matrix builds for travis 2016-12-09 13:10:19 +01:00
stack.yaml Makes stack.yaml a link again 2017-03-18 20:52:08 +01:00

README.md

An API client for docker written in Haskell

Master
master

Current state

Supported Docker Engine Api version: v1.24 and onwards.

Anything upward of that should work since Docker versions their API. Older docker version and engine api versions are not supported at the moment.

Documentation

The API-documentation is available at Hackage. There are also some usage-examples in the main library source file, Client.hs.

Contributing

Please see CONTRIBUTING.md.

Project Setup

For working on the library, you need the Haskell Tool Stack installed (see the Haskell Tool Stack website). You also need make to use the Makefile included in the project. Run make help to see the available commands (for building, running the tests and releasing).

Tests

Tests are located in the tests directory and can be run with make test. This only runs the unit tests.

To run integration tests, you need Docker installed and listening on Port 2375 of localhost (docker only listens to a Unix socket by default, see the Docker documentation for details). Set the environment variable RUN_INTEGRATION_TESTS, i.e. RUN_INTEGRATION_TESTS=1 make test.

IRC

If you have any questions or suggestions you can find the maintainers in #docker-haskell on freenode.