config

Documentation

Index

• type AuthConfig
• type ClientConfig
  • func (c *ClientConfig) NewWebSocketConfig() (*websocket.Config, error)
  • func (c *ClientConfig) WebSocketURL() string
• type Config
  • func LoadConfig() (*Config, error)
• type DatabaseConfig
• type PortMapping
• type ServerConfig
  • func (c *ServerConfig) HTTPURL() string
  • func (c *ServerConfig) SubdomainURL(id string) string

Types

type AuthConfig

type AuthConfig struct {
	GithubClientId     string `env:"GITHUB_CLIENT_ID" required:"true"`
	GithubClientSecret string `env:"GITHUB_CLIENT_SECRET" required:"true"`
}

type ClientConfig

type ClientConfig struct {
	Ports     []PortMapping // The ports the client is tunneling
	ServerURL string        // The server URL to connect to when handling tunnels
	Token     string        // The auth token set VIA --login
}

ClientConfig will be set by the CLI app

func (*ClientConfig) NewWebSocketConfig

func (c *ClientConfig) NewWebSocketConfig() (*websocket.Config, error)

NewWebSocketConfig creates a websocket.Config for CLI usage

func (*ClientConfig) WebSocketURL

func (c *ClientConfig) WebSocketURL() string

WebSocketURL returns the WebSocket URL (ws:// or wss://) of the server for the client to connect to

type Config

type Config struct {
	Server   ServerConfig
	Database DatabaseConfig
}

func LoadConfig

func LoadConfig() (*Config, error)

type DatabaseConfig

type DatabaseConfig struct {
	Path string `env:"DB_PATH" required:"true"`
}

type PortMapping

type PortMapping struct {
	Port     int
	CustomId string
}

type ServerConfig

type ServerConfig struct {
	BaseURL string `env:"SERVER_URL" required:"true"`
	Port    string `env:"SERVER_PORT"`

	UseSubdomains bool `env:"USE_SUBDOMAINS" default:"false"`

	Auth AuthConfig

	Logger *slog.Logger
	// contains filtered or unexported fields
}

func (*ServerConfig) HTTPURL

func (c *ServerConfig) HTTPURL() string

HTTPURL returns the full HTTP URL of the server

func (*ServerConfig) SubdomainURL

func (c *ServerConfig) SubdomainURL(id string) string

SubdomainURL converts the server's base URL to a subdomainURL based on the id using the custom logic for local development and production