go-dockerpty

Provides the functionality needed to operate the pseudo-tty (PTY) allocated to a docker container, using the Go client.

Inspired by https://github.com/d11wtq/dockerpty

⚠️ Unmaintained ⚠️

Project is no longer being maintained and has been archived.

Usage

This package provides two functions: dockerpty.Start and dockerpty.StartExec.

The following example will run Busybox in a docker container and place the user at the shell prompt via Go. It is the same as running docker run -ti --rm busybox /bin/sh.

This obviously only works when run in a terminal.

package main

import (
	"fmt"
	"github.com/fgrehm/go-dockerpty"
	"github.com/fsouza/go-dockerclient"
	"os"
)

func main() {
	endpoint := "unix:///var/run/docker.sock"
	client, _ := docker.NewClient(endpoint)

	// Create container
	container, err := client.CreateContainer(docker.CreateContainerOptions{
		Config: &docker.Config{
			Image:        "busybox",
			Cmd:          []string{"/bin/sh"},
			OpenStdin:    true,
			StdinOnce:    true,
			AttachStdin:  true,
			AttachStdout: true,
			AttachStderr: true,
			Tty:          true,
		},
	})

	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Cleanup when done
	defer func() {
		client.RemoveContainer(docker.RemoveContainerOptions{
			ID: container.ID,
			Force: true,
		})
	}()

	// Fire up the console
	if err = dockerpty.Start(client, container, &docker.HostConfig{}); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}

The following example will run a "date service" on a Busybox docker container and place the user at the shell prompt via Go. It is the same as running docker exec -ti date-service /bin/sh.

This obviously only works when run in a terminal.

package main

import (
	"fmt"
	"github.com/fgrehm/go-dockerpty"
	"github.com/fsouza/go-dockerclient"
	"os"
)

func main() {
	endpoint := "unix:///var/run/docker.sock"
	client, _ := docker.NewClient(endpoint)

	// Create container
	container, err := client.CreateContainer(docker.CreateContainerOptions{
		Name: "date-service",
		Config: &docker.Config{
			Image: "busybox",
			Cmd:   []string{"/bin/sh", "-c", "while true; do date >> /tmp/date.log; sleep 1; done"},
		},
	})

	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Cleanup when done
	defer func() {
		client.RemoveContainer(docker.RemoveContainerOptions{
			ID: container.ID,
			Force: true,
		})
	}()

	err = client.StartContainer(container.ID, &docker.HostConfig{})

	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	exec, err := client.CreateExec(docker.CreateExecOptions{
		Container:    container.ID,
		AttachStdin:  true,
		AttachStdout: true,
		AttachStderr: true,
		Tty:          true,
		Cmd:          []string{"/bin/sh"},
	})

	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	// Fire up the console
	if err = dockerpty.StartExec(client, exec); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}

When dockerpty.Start or dockerpty.StartExec gets called, control is yielded to the container's PTY until the container exits, or the container's PTY is closed.

This is a safe operation and all resources should be restored back to their original states.