Affected by 
Documentation
¶
Overview ¶
Package run contains the command to run an OpenFGA server.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MustDefaultConfigWithRandomPorts ¶
func MustDefaultConfigWithRandomPorts() *serverconfig.Config
MustDefaultConfigWithRandomPorts is meant to be used for tests only (TODO move to test utils). It returns default server config but with random ports for the grpc and http addresses and with the playground, tracing and metrics turned off. This function may panic if somehow a random port cannot be chosen.
func NewRunCommand ¶
func ReadConfig ¶
func ReadConfig() (*serverconfig.Config, error)
ReadConfig returns the OpenFGA server configuration based on the values provided in the server's 'config.yaml' file. The 'config.yaml' file is loaded from '/etc/openfga', '$HOME/.openfga', or the current working directory. If no configuration file is present, the default values are returned.
func TCPRandomPort ¶ added in v0.4.3
func TCPRandomPort() (int, func())
TCPRandomPort tries to find a random TCP Port. If it can't find one, it panics. Else, it returns the port and a function that releases the port. It is the responsibility of the caller to call the release function.
Types ¶
type ServerContext ¶ added in v1.3.1
func (*ServerContext) Run ¶ added in v1.3.1
func (s *ServerContext) Run(ctx context.Context, config *serverconfig.Config) error
Run returns an error if the server was unable to start successfully. If it started and terminated successfully, it returns a nil error.
Source Files