server

Documentation

Overview

Package server implements Kopia API server handlers.

Index

• func AssetFile() http.FileSystem
• type Options
• type Server
  • func New(ctx context.Context, options Options) (*Server, error)
  • func (s *Server) APIHandlers(legacyAPI bool) http.Handler
  • func (s *Server) GRPCRouterHandler(handler http.Handler) http.Handler
  • func (s *Server) Refresh(ctx context.Context) error
  • func (s *Server) RegisterGRPCHandlers(r grpc.ServiceRegistrar)
  • func (s *Server) RequireUIUserAuth(hf http.Handler) http.Handler
  • func (s *Server) Session(srv grpcapi.KopiaRepository_SessionServer) error
  • func (s *Server) SetRepository(ctx context.Context, rep repo.Repository) error
  • func (s *Server) StopAllSourceManagers(ctx context.Context)
  • func (s *Server) SyncSources(ctx context.Context) error

Functions

func AssetFile

func AssetFile() http.FileSystem

AssetFile return a http.FileSystem instance that data backend by asset.

Types

type Options

type Options struct {
	ConfigFile           string
	ConnectOptions       *repo.ConnectOptions
	RefreshInterval      time.Duration
	MaxConcurrency       int
	Authenticator        auth.Authenticator
	Authorizer           auth.Authorizer
	PasswordPersist      passwordpersist.Strategy
	AuthCookieSigningKey string
	LogRequests          bool
	UIUser               string // name of the user allowed to access the UI
}

Options encompasses all API server options.

type Server

type Server struct {
	OnShutdown func(ctx context.Context) error
	// contains filtered or unexported fields
}

Server exposes simple HTTP API for programmatically accessing Kopia features.

func New

func New(ctx context.Context, options Options) (*Server, error)

New creates a Server. The server will manage sources for a given username@hostname.

func (*Server) APIHandlers

func (s *Server) APIHandlers(legacyAPI bool) http.Handler

APIHandlers handles API requests.

func (*Server) GRPCRouterHandler

func (s *Server) GRPCRouterHandler(handler http.Handler) http.Handler

GRPCRouterHandler returns HTTP handler that supports GRPC services and routes non-GRPC calls to the provided handler.

func (*Server) Refresh

func (s *Server) Refresh(ctx context.Context) error

Refresh refreshes the state of the server in response to external signal (e.g. SIGHUP).

func (*Server) RegisterGRPCHandlers

func (s *Server) RegisterGRPCHandlers(r grpc.ServiceRegistrar)

RegisterGRPCHandlers registers server gRPC handler.

func (*Server) RequireUIUserAuth

func (s *Server) RequireUIUserAuth(hf http.Handler) http.Handler

RequireUIUserAuth wraps the provided http.Handler to only allow UI user and return 403 otherwise.

func (*Server) Session

func (s *Server) Session(srv grpcapi.KopiaRepository_SessionServer) error

Session handles GRPC session from a repository client.

func (*Server) SetRepository

func (s *Server) SetRepository(ctx context.Context, rep repo.Repository) error

SetRepository sets the repository (nil is allowed and indicates server that is not connected to the repository).

func (*Server) StopAllSourceManagers

func (s *Server) StopAllSourceManagers(ctx context.Context)

StopAllSourceManagers causes all source managers to stop.

func (*Server) SyncSources

func (s *Server) SyncSources(ctx context.Context) error

SyncSources synchronizes the repository and source managers.