##About

###Description Docker image designed to run a Consul cluster on ContainerShip

###Author ContainerShip Developers - [email protected]

##Usage This image is designed to run Consul on a ContainerShip cluster. Running this image elsewhere is not recommended as the container may be unable to start.

###Configuration This image will run as-is, with no additional environment variables set. For clustering to work properly, start the application in host networking mode. There are various optionally configurable environment variables:

• CONSUL_UI - enable / disable consul UI. defaults to 'true'

• On your ContainerShip cluster, run this application using the constraints.per_node=1 tag. Each node in your cluster will run an instance of Consul, creating a cluster of n hosts, where n is the number of follower hosts in your ContainerShip cluster.
• Start the application with container_volume=/consul/data data is managed by CodexD in case your container crashes.

##Contributing Pull requests and issues are encouraged!