README.md

docker-socket-proxy

What is this?

This is a fork of https://github.com/Tecnativa/docker-socket-proxy with added https support and updated haproxy.
Note: this fork is distributed under the GNU Affero General Public License version 3 or any later version. It is based on the Apache-2.0 licensed upstream.

Grant or revoke access to certain API sections

You grant and revoke access to certain features of the Docker API through environment variables.

Normally the variables match the URL prefix (i.e. AUTH blocks access to /auth/* parts of the API, etc.).

Possible values for these variables:

• 0 to revoke access.
• 1 to grant access.

Access granted by default

These API sections are mostly harmless and almost required for any service that uses the API, so they are granted by default.

• EVENTS
• PING
• VERSION

Access revoked by default

Security-critical

These API sections are considered security-critical, and thus access is revoked by default. Maximum caution when enabling these.

• AUTH
• SECRETS
• POST: When disabled, all POST operations are blocked, meaning any section of the API is read-only.
• ALL: Allows everything, except for POST if not enabled

Not always needed

You will possibly need to grant access to some of these API sections, which are not so extremely critical but can expose some information that your service does not need.

• ALLOW_POWER (containers/id/start|stop|kill|restart|pause|unpause)
• ALLOW_RESTART (containers/id/restart)
• ALLOW_RESTARTS (containers/id/stop|restart|kill)
• ALLOW_START (containers/id/start)
• ALLOW_STOP (containers/id/stop)
• ALLOW_Kill (containers/id/kill)
• ALLOW_PAUSE (containers/id/pause)
• ALLOW_UNPAUSE (containers/id/unpause)
• BUILD
• COMMIT
• CONFIGS
• CONTAINERS
• DISTRIBUTION
• EXEC
• GRPC
• IMAGES
• INFO
• NETWORKS
• NODES
• PLUGINS
• SERVICES
• SESSION
• SWARM
• SYSTEM
• TASKS
• VOLUMES