server

Documentation

Overview

Package server implements the entry point for running a robot web server.

Package server implements the entry point for running a robot web server.

Index

• Variables
• func RunServer(ctx context.Context, args []string, _ logging.Logger) (err error)
• type Arguments

Variables

var ForceRestart bool

ForceRestart lets random other parts of the app request an exit.

Functions

func RunServer

func RunServer(ctx context.Context, args []string, _ logging.Logger) (err error)

RunServer is an entry point to starting the web server that can be called by main in a code sample or otherwise be used to initialize the server.

Types

type Arguments

type Arguments struct {
	AllowInsecureCreds         bool   `flag:"allow-insecure-creds,usage=allow connections to send credentials over plaintext"`
	ConfigFile                 string `flag:"config,usage=robot config file"`
	CPUProfile                 string `flag:"cpuprofile,usage=write cpu profile to file"`
	Debug                      bool   `flag:"debug"`
	Logging                    bool   `flag:"logging,default=false,usage=emit periodic resource status information to Viam's hidden folder"`
	SharedDir                  string `flag:"shareddir,usage=web resource directory"`
	Version                    bool   `flag:"version,usage=print version"`
	WebProfile                 bool   `flag:"webprofile,usage=include profiler in http server"`
	WebRTC                     bool   `flag:"webrtc,default=true,usage=force webrtc connections instead of direct"`
	RevealSensitiveConfigDiffs bool   `flag:"reveal-sensitive-config-diffs,usage=show config diffs"`
	UntrustedEnv               bool   `flag:"untrusted-env,usage=disable processes and shell from running in a untrusted environment"`
	OutputTelemetry            bool   `flag:"output-telemetry,usage=print out telemetry data (metrics and spans)"`
	DisableMulticastDNS        bool   `flag:"disable-mdns,usage=disable server discovery through multicast DNS"`
	DumpResourcesPath          string `flag:"dump-resources,usage=dump all resource registrations as json to the provided file path"`
}

Arguments for the command.