portal

Documentation

Overview

Package portal provides SSH portals to applications.

Index

• Constants
• type Portal
  • func New(name string, address string, command []string) (*Portal, error)
  • func (p *Portal) Close()
  • func (p *Portal) Shutdown()

Constants

const (
	// ListenTimeout is the maximum time to start listening on an address.
	ListenTimeout = 1 * time.Second

	// IdleTimeout is the maximum time for a connection to be inactive.
	IdleTimeout = 1 * time.Minute
)

Types

type Portal

type Portal struct {
	Name    string
	Address string
	Command []string
	Server  *ssh.Server
}

Portal is an SSH portal to an application.

func New

func New(name string, address string, command []string) (*Portal, error)

New opens an SSH portal to an application.

func (*Portal) Close

func (p *Portal) Close()

Close closes the portal immediately.

func (*Portal) Shutdown

func (p *Portal) Shutdown()

Shutdown closes the portal without interrupting active connections.