CLI Reference¶
Docker Socket Proxy provides a command-line interface for managing the proxy server and sockets. This reference documents all available commands and their options.
Global Options¶
These options apply to all commands:
daemon¶
Starts the Docker Socket Proxy daemon. The daemon proxies requests to the Docker daemon and also provides a management socket so that it can be configured.
Options¶
--management-socket string Path to the management socket (default "/var/run/docker-proxy/management.sock")
--docker-socket string Path to the Docker daemon socket (default "/var/run/docker.sock")
Example¶
# Start the daemon with default settings
docker-socket-proxy daemon
# Start the daemon with a custom Docker socket
docker-socket-proxy daemon --docker-socket /path/to/custom/docker.sock
socket¶
Commands for managing proxy sockets.
Available Commands¶
create: Create a new proxy socketdelete: Delete an existing proxy socketlist: List all available proxy socketsdescribe: Show details about a proxy socket
socket create¶
Creates a new proxy socket with the specified configuration.
Options¶
--config, -c string Path to socket configuration file (yaml)
--output Output format, options are: yaml, json, text, silent (defaults to yaml)
Example¶
# Create a new socket with a configuration file
docker-socket-proxy socket create -c /path/to/config.yaml
socket delete¶
Deletes an existing proxy socket.
Example¶
# Delete a socket by name
docker-socket-proxy socket delete my-socket.sock
# Delete a socket by full path
docker-socket-proxy socket delete /var/run/docker-proxy/my-socket.sock
socket list¶
Lists all available proxy sockets.
Example¶
socket describe¶
Shows detailed information about a proxy socket, including its configuration.