router_settings.rst

title:	Customizing router
description:	Learn how to tune custom Deis settings.

Customizing router

The following settings are tunable for the :ref:`router` component.

Dependencies

Requires: :ref:`builder <builder_settings>`, :ref:`controller <controller_settings>`

Required by: none

Considerations: none

Settings set by router

The following etcd keys are set by the router component, typically in its /bin/boot script.

setting	description
/deis/router/$HOST/host	IP address of the host running this router (there can be multiple routers)
/deis/router/$HOST/port	port used by this router service (there can be multiple routers) (default: 80)

Settings used by router

The following etcd keys are used by the router component.

Using a custom router image

You can use a custom Docker image for the router component instead of the image supplied with Deis:

$ etcdctl set /deis/router/image myaccount/myimage:latest

This will pull the image from the public Docker registry. You can also pull from a private registry:

$ etcdctl set /deis/router/image registry.mydomain.org:5000/myaccount/myimage:latest

Be sure that your custom image functions in the same way as the stock router image shipped with Deis. Specifically, ensure that it sets and reads appropriate etcd keys.