server

Documentation

Index

• func SessionHandler(ac *appCfg.Config) bm.ProgramHandler
• type Server
  • func NewServer(cfg *config.Config) *Server
  • func (srv *Server) Close() error
  • func (srv *Server) Reload() error
  • func (srv *Server) Serve(l net.Listener) error
  • func (srv *Server) Shutdown(ctx context.Context) error
  • func (srv *Server) Start() error

Functions

func SessionHandler

func SessionHandler(ac *appCfg.Config) bm.ProgramHandler

SessionHandler is the soft-serve bubbletea ssh session handler.

Types

type Server

type Server struct {
	SSHServer *ssh.Server
	Config    *config.Config
	// contains filtered or unexported fields
}

Server is the Soft Serve server.

func NewServer

func NewServer(cfg *config.Config) *Server

NewServer returns a new *ssh.Server configured to serve Soft Serve. The SSH server key-pair will be created if none exists. An initial admin SSH public key can be provided with authKey. If authKey is provided, access will be restricted to that key. If authKey is not provided, the server will be publicly writable until configured otherwise by cloning the `config` repo.

func (*Server) Close

func (srv *Server) Close() error

Close closes the SSH server.

func (*Server) Reload

func (srv *Server) Reload() error

Reload reloads the server configuration.

func (*Server) Serve

func (srv *Server) Serve(l net.Listener) error

Serve serves the SSH server using the provided listener.

func (*Server) Shutdown

func (srv *Server) Shutdown(ctx context.Context) error

Shutdown lets the server gracefully shutdown.

func (*Server) Start

func (srv *Server) Start() error

Start starts the SSH server.