/** * Http, https, ssh, and unix socket connection agents for all platforms. * * @see https://github.com/leonitousconforti/the-moby-effect/blob/main/src/MobyConnection.ts */ import type { MobyConnection } from 'docker-api-types'; /** * From * https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-socket-option * https://docs.docker.com/reference/cli/docker/#host * * "The Docker client will honor the DOCKER_HOST environment variable to set the * -H flag for the client" * * And then from * https://docs.docker.com/engine/reference/commandline/dockerd/#bind-docker-to-another-hostport-or-a-unix-socket * * "-H accepts host and port assignment in the following format: * `tcp://[host]:[port][path]` or `unix://path` * * For example: * * - `unix://path/to/socket` -> Unix socket located at path/to/socket. * When -H is empty, it will default to the same value as when no -H was passed in * - `http://host:port/path` -> HTTP connection on host:port and prepend path to * all requests * - `https://host:port/path` -> HTTPS connection on host:port and prepend path to * all requests * - `ssh://me@example.com:22/var/run/docker.sock` -> SSH connection to * example.com on port 22 * * @see https://github.com/leonitousconforti/the-moby-effect/blob/main/src/internal/platforms/connection.ts */ export declare const connectionOptionsFromUrl: (dockerHost: string) => MobyConnection.MobyConnectionOptions; /** * Connection options from the DOCKER_HOST environment variable as a url. */ export declare const ENV_CONNECTION_OPTIONS: MobyConnection.MobyConnectionOptions; /** * Connection options from the platform default system socket location. */ export declare const UNIX_SOCKET_CONNECTION_OPTIONS: Extract; //# sourceMappingURL=connection.d.ts.map