docker-gateway

docker-gateway

Revese proxy for Docker containers

Overview

Docker gateway project is a simple HTTP reverse proxy that makes containers accessible if they expose any TCP ports. It will also listen for docker events and bring up / take down hosts automatically. Gateway project is very similar to nginx-proxy but implemented in Go and does not require any dependencies.

IMPORTANT: Please keep in mind that this project is only intended to be used for development purposes and experiments with Docker containers.

Install

From source:

go get github.com/sosedoff/docker-gateway

From github releases:

https://github.com/sosedoff/docker-gateway/releases

From docker registry:

docker pull sosedoff/docker-gateway

Usage

First, make sure you have Docker running without TLS support. That usually mean that it should be running on port 2375 (instead of 2376 for tls).

Then start gateway:

DOCKER_HOST=tcp://127.0.0.1:2375 \
GW_DOMAIN=docker.dev \
docker-gateway

Gateway will start on http://0.0.0.0:2377.

Now, you will need to start a few containers:

docker run -d -e DOMAIN=test1.docker.dev sosedoff/dummy-service
docker run -d -e DOMAIN=test2.docker.dev sosedoff/dummy-service
docker run -d -e DOMAIN=test3.docker.dev sosedoff/dummy-service

Gateway will automatically map those container to: http://test(1,2,3).docker.dev/

Using with nginx

http {
  upstream docker_gateway {
    server 127.0.0.1:2377;
  }

  server {
    listen 80;
    server_name *.mydomain.dev;

    location / {
      proxy_set_header Host $http_host;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_pass http://docker_gateway;
      proxy_redirect off;
    }
  }
}

Using with Docker

Pull image first:

docker pull sosedoff/docker-gateway

Start container (will start on port 80):

docker run -d \
  -p 80:2377 \
  --restart always \
  -e GW_DOMAIN=mydomain.com \
  -e DOCKER_HOST=tcp://172.17.42.1:2375 \
  sosedoff/docker-gateway

Options

List of all environment variables used by gateway:

• GW_DOMAIN - Domain name to be used for all containers.
• GW_SKIP_NO_DOMAIN - Skip containers that dont have DOMAIN variable set
• GW_DEFAULT_ROUTE - Endpoint (in format ip:port) to which proxy any request that could not routed
• BOUNCE_BOTS - Respond with 404 for any request many by robots

Development

There are few make tasks available:

• make setup - Install dependencies
• make build - Build a binary for current environment
• make all - Build binaries for Linux and OSX (amd64 only)
• make clean - Remove temp files
• make docker - Build docker image

License

The MIT License (MIT)