consoleweb

Documentation

Index

• Constants
• Variables
• type Config
• type Server
  • func NewServer(logger *zap.Logger, config Config, service *console.Service, ...) *Server
  • func (server *Server) Close() error
  • func (server *Server) Run(ctx context.Context) (err error)

Constants

const ContentLengthLimit = 4 * memory.KB

ContentLengthLimit describes 4KB limit.

Variables

var (
	// Error is satellite console error type.
	Error = errs.Class("satellite console error")
)

Types

type Config

type Config struct {
	Address         string `help:"server address of the graphql api gateway and frontend app" devDefault:"127.0.0.1:8081" releaseDefault:":10100"`
	StaticDir       string `help:"path to static resources" default:""`
	ExternalAddress string `help:"external endpoint of the satellite if hosted" default:""`

	// TODO: remove after Vanguard release
	AuthToken       string `help:"auth token needed for access to registration token creation endpoint" default:""`
	AuthTokenSecret string `help:"secret used to sign auth tokens" releaseDefault:"" devDefault:"my-suppa-secret-key"`

	ContactInfoURL               string `help:"url link to contacts page" default:"https://forum.storj.io"`
	FrameAncestors               string `help:"allow domains to embed the satellite in a frame, space separated" default:"tardigrade.io"`
	LetUsKnowURL                 string `help:"url link to let us know page" default:"https://storjlabs.atlassian.net/servicedesk/customer/portals"`
	SEO                          string `help:"used to communicate with web crawlers and other web robots" default:"User-agent: *\nDisallow: \nDisallow: /cgi-bin/"`
	SatelliteName                string `help:"used to display at web satellite console" default:"Storj"`
	SatelliteOperator            string `help:"name of organization which set up satellite" default:"Storj Labs" `
	TermsAndConditionsURL        string `help:"url link to terms and conditions page" default:"https://storj.io/storage-sla/"`
	SegmentIOPublicKey           string `help:"used to initialize segment.io at web satellite console" default:""`
	AccountActivationRedirectURL string `help:"url link for account activation redirect" default:""`
	VerificationPageURL          string `help:"url link to sign up verification page" default:"https://tardigrade.io/verify"`
	PartneredSatelliteNames      string `help:"names of partnered satellites" default:"US-Central-1,Europe-West-1,Asia-East-1"`
	GoogleTagManagerID           string `help:"id for google tag manager" default:""`

	RateLimit web.IPRateLimiterConfig

	console.Config
}

Config contains configuration for console web server.

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server represents console web server

architecture: Endpoint

func NewServer

func NewServer(logger *zap.Logger, config Config, service *console.Service, mailService *mailservice.Service, referralsService *referrals.Service, partners *rewards.PartnersService, listener net.Listener, stripePublicKey string) *Server

NewServer creates new instance of console server.

func (*Server) Close

func (server *Server) Close() error

Close closes server and underlying listener.

func (*Server) Run

func (server *Server) Run(ctx context.Context) (err error)

Run starts the server that host webapp and api endpoint.