Update README with instructions for Docker

[iBobik]

Today README.md looks like documentation for command line utility. But it is Docker image and it should be used differentely.

So, is is excess to have in README:

• dependencies of Python utility
• configuration by copying files
• how to start daemon (it should start automatically in this image)

But in README for Docker image should be:

• example how to run it (docker run ...)
• example how to configure it by docker run parameters
• recommanded way how to link it with application container

[alexandernst]

I'm not really sure you understand what this project is, but it's certainly not a docker image nor it has to do anything with docker.

[olipo186]

Hi,

As @alexandernst suggests, using this repository as a Docker image has not historically been our primary use case. Nor do I believe that the majority of it's users uses it using Docker.

However, we do offer some support for using the repository as a Docker image thanks to additions from @alexanderkjeldaas.

I would very much like to see some instructions in the README on how to use this repository as a Docker image. We can split up the instructions in separate sections for different use cases. @iBobik, is this something that you can help us with?

[iBobik]

Aha, docket is just another use case. I think divide it to sections (Use as command line utility, Docker image) can be helpful.

I don't know this project, but I can write you draft how I expected it will work. Then you can treat as a feature request or docs to publish if it fits.

What do you think?

Jan Pobořil http://honza.poboril.cz/

02 Oct 2015 v 10:29, Oliver Poignant [email protected]:

Hi,

As @alexandernst suggest, using this repository as a Docker image has not historically been our primary use case. Nor do I believe that the majority of it's users uses it using Docker.

However, we do offer some support for using the repository as a Docker image thanks to additions from @alexanderkjeldaas.

I would very much like to see some instructions in the README on how to use this repository as a Docker image. We can split up the instructions in separate sections for different use cases. @iBobik, is this something that you can help us with?

— Reply to this email directly or view it on GitHub.

[olipo186]

@iBobik, that would be much appreciated!

[iBobik]

I'll also add example use in docker-compose.yml with cool volumes_from directive. I just need to test it somewhen.