Interface TechDocsContainerRunner

runContainer

• runContainer(
      opts: {
          args: string[];
          command?: string | string[];
          defaultUser?: boolean;
          envVars?: Record<string, string>;
          imageName: string;
          logStream?: Writable;
          mountDirs?: Record<string, string>;
          pullImage?: boolean;
          pullOptions?: {
              authconfig?: {
                  auth?: string;
                  email?: string;
                  password?: string;
                  serveraddress?: string;
                  username?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          };
          workingDir?: string;
      },
  ): Promise<void>

  Runs a container image to completion.

  Parameters

  • opts: {
        args: string[];
        command?: string | string[];
        defaultUser?: boolean;
        envVars?: Record<string, string>;
        imageName: string;
        logStream?: Writable;
        mountDirs?: Record<string, string>;
        pullImage?: boolean;
        pullOptions?: {
            authconfig?: {
                auth?: string;
                email?: string;
                password?: string;
                serveraddress?: string;
                username?: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
        workingDir?: string;
    }

  Returns Promise<void>