conf

Documentation

Overview

Package conf writes and reads the Encore configuration file for the user.

Index

• Variables
• func CacheDir() (string, error)
• func DataDir() (string, error)
• func Dir() (string, error)
• func Logout() error
• func Write(cfg *Config) (err error)
• type Config
  • func CurrentUser() (*Config, error)
  • func OriginalUser(configDir string) (cfg *Config, err error)
• type TokenSource
  • func NewTokenSource() *TokenSource
  • func (ts *TokenSource) Token() (*oauth2.Token, error)

Variables

var APIBaseURL = (func() string {
	if u := os.Getenv("ENCORE_PLATFORM_API_URL"); u != "" {
		return u
	}
	return defaultPlatformURL
})()

APIBaseURL is the base URL for communicating with the Encore Platform.

var AuthClient = oauth2.NewClient(nil, DefaultTokenSource)

AuthClient is an *http.Client that authenticates requests using the logged-in user.

var CacheDevDash = (func() bool {
	return !strings.Contains(DevDashURL, "localhost")
})()

CacheDevDash reports whether or not the dev dash contents should be cached.

var DefaultClient = &http.Client{Transport: defaultTransport{}}

DefaultClient is an *http.Client that authenticates requests if the user is logged in. If the user is not logged in, the request is sent without authentication.

var DefaultTokenSource = NewTokenSource()

var DevDaemon = (func() bool {
	return os.Getenv("ENCORE_DAEMON_DEV") != ""
})()

DevDaemon reports whether or not the daemon is running in development mode.

var DevDashURL = (func() string {
	if u := os.Getenv("ENCORE_DEVDASH_URL"); u != "" {
		return u
	}
	return defaultDevDashURL
})()

DevDashURL is the base URL to retrieve the dev dashboard code from.

var ErrInvalidRefreshToken = errors.New("invalid refresh token")

var ErrNotLoggedIn = errors.New("not logged in: run 'encore auth login' first")

var WSBaseURL = (func() string {
	return strings.Replace(APIBaseURL, "http", "ws", -1)
})()

WSBaseURL is the base URL for communicating with the Encore Platform over WebSocket.

Functions

func CacheDir

func CacheDir() (string, error)

CacheDir reports the base directory for storing data which can be cached and deleted at any time by the user without affecting the Encore daemon.

The directory may or may not exist already.

func DataDir

func DataDir() (string, error)

DataDir reports the base directory for storing data, like database volumes. The directory may or may not exist already.

func Dir

func Dir() (string, error)

Dir reports the directory where Encore's configuration is stored.

func Logout

func Logout() error

func Write

func Write(cfg *Config) (err error)

Write persists the configuration for the user.

Types

type Config

type Config struct {
	oauth2.Token
	Actor     string `json:"actor,omitempty"`    // The ID of either the user or app authenticated
	Email     string `json:"email,omitempty"`    // non-zero if logged in as a user
	AppSlug   string `json:"app_slug,omitempty"` // non-zero if logged in as an app
	WireGuard struct {
		PublicKey  string `json:"pub,omitempty"`
		PrivateKey string `json:"priv,omitempty"`
	} `json:"wg,omitempty"`
}

Config represents the stored Encore configuration.

func CurrentUser

func CurrentUser() (*Config, error)

func OriginalUser

func OriginalUser(configDir string) (cfg *Config, err error)

type TokenSource

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

TokenSource implements oauth2.TokenSource by looking up the current logged in user's API Token.

func NewTokenSource

func NewTokenSource() *TokenSource

func (*TokenSource) Token

func (ts *TokenSource) Token() (*oauth2.Token, error)

Token implements oauth2.TokenSource.