docker_exposer

README

docker-exposer

Description

This is a simple server that exposes the docker socket to the outside world through http.

Although docker daemon already supports remote access via http, built-in authentication method is very limited.

You can expose your docker socket with additional features built-in or with your own.

Quick Start

WARNING

This project itself does not provide any authentication mechanism by default. NEVER expose this server to the public internet without additional authentication mechanism.

native

go install github.com/palindrom615/docker-exposer/cmd/docker-exposer@latest
~/go/bin/docker-exposer --port 2375 --docker-host unix://$HOME/.colima/docker.sock \
  --auth-type basic --basic-auth-username alice --basic-auth-password pa55word

docker

DOCKER_HOST=/var/run/docker.sock
docker run -d -p 2375:2375 \
  -v $DOCKER_HOST:/var/run/docker.sock \
  -e AUTH_TYPE=basic \
  -e BASIC_AUTH_USERNAME=alice \
  -e BASIC_AUTH_PASSWORD=pa55word \
  --name docker-exposer \
  ghcr.io/palindrom615/docker-exposer:latest

Options

CLI options

flag	description	default
--port	port number to listen	2375
--auth-type	authentication type. basic and auth0 is supported. anything else is ignored.	os.Getenv("AUTH_TYPE")
--basic-auth-username	basic auth username	os.Getenv("BASIC_AUTH_USERNAME")
--basic-auth-password	basic auth password	os.Getenv("BASIC_AUTH_PASSWORD")
--docker-host	docker host to connect	-
--docker-tlscacert	path to CA cert on tls connect	-
--docker-tlscert	path to cert on tls	-
--docker-tlskey	path to key on tls	-

Environment variables

• .env file is supported.
• CLI options are prioritized over environment variables.
• DOCKER_HOST, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS_VERIFY are supported by docker client library

variable name	description	default
AUTH_TYPE	authentication type	-
BASIC_AUTH_USERNAME	basic auth username	-
BASIC_AUTH_PASSWORD	basic auth password	-
AUTH0_DOMAIN	auth0 domain	-
AUTH0_AUDIENCE	auth0 audience	-

built-in authentication

basic auth

Built-in basic auth implementation only supports single username and password given by --basic-auth-username and --basic-auth-password.

auth0

built-in auth0 implementation supports auth0 Backend/API authentication. this implementation requires environment variable AUTH0_DOMAIN for your auth0 tenant and AUTH0_AUDIENCE for your auth0 api ID.

Documentation

Index

• type DockerRelay
  • func NewDockerRelay(opts ...client.Opt) *DockerRelay
  • func (d *DockerRelay) Close() error
  • func (c *DockerRelay) RoundTrip(req *http.Request) (*http.Response, error)
  • func (d *DockerRelay) ServeHTTP(w http.ResponseWriter, req *http.Request)

Types

type DockerRelay

type DockerRelay struct {
	// contains filtered or unexported fields
}

func NewDockerRelay

func NewDockerRelay(opts ...client.Opt) *DockerRelay

func (*DockerRelay) Close

func (d *DockerRelay) Close() error

func (*DockerRelay) RoundTrip

func (c *DockerRelay) RoundTrip(req *http.Request) (*http.Response, error)

func (*DockerRelay) ServeHTTP

func (d *DockerRelay) ServeHTTP(w http.ResponseWriter, req *http.Request)