config

Documentation

Index

• type AdminAPIConfig
• type AdminAPIType
• type AppConfig
• type AppKubernetesConfig
• type AuditLogConfig
• type AuthgearConfig
• type DomainImplementationType
• type GoogleTagManagerConfig
• type KubernetesConfig
• type MailConfig
• type SMTPConfig
• type SearchConfig
• type StripeConfig
• type Web3Config

Types

type AdminAPIConfig

type AdminAPIConfig struct {
	Type AdminAPIType        `envconfig:"TYPE" default:"static"`
	Auth config.AdminAPIAuth `envconfig:"AUTH" default:"jwt"`
	// Endpoint is used in http.Request.URL to connect the server.
	Endpoint string `envconfig:"ENDPOINT" default:"http://localhost:3002"`
	// HostTemplate is used in http.Request.Host for tenant resolution.
	HostTemplate string `envconfig:"HOST_TEMPLATE" default:"localhost:3002"`
}

type AdminAPIType

type AdminAPIType string

const (
	AdminAPITypeStatic AdminAPIType = "static"
)

type AppConfig

type AppConfig struct {
	HostSuffix string              `envconfig:"HOST_SUFFIX"`
	IDPattern  string              `envconfig:"ID_PATTERN" default:"^[a-z0-9][a-z0-9-]{2,30}[a-z0-9]$"`
	Kubernetes AppKubernetesConfig `envconfig:"KUBERNETES"`

	// BuiltinResourceDirectory sets the directory for built-in resource files
	BuiltinResourceDirectory string `envconfig:"BUILTIN_RESOURCE_DIRECTORY" default:"resources/authgear"`
	// CustomResourceDirectory sets the directory for customized resource files
	CustomResourceDirectory string `envconfig:"CUSTOM_RESOURCE_DIRECTORY"`
	// MaxOwnedApps controls how many apps a user can own.
	MaxOwnedApps int `envconfig:"MAX_OWNED_APPS" default:"-1"`
	// DefaultPlan defines the default plan for apps during app creation
	DefaultPlan string `envconfig:"DEFAULT_PLAN"`
}

type AppKubernetesConfig

type AppKubernetesConfig struct {
	IngressTemplateFile string `envconfig:"INGRESS_TEMPLATE_FILE"`
}

type AuditLogConfig

type AuditLogConfig struct {
	Enabled bool `envconfig:"ENABLED" default:"false"`
}

type AuthgearConfig

type AuthgearConfig struct {
	ClientID string `envconfig:"CLIENT_ID"`
	Endpoint string `envconfig:"ENDPOINT"`
	AppID    string `envconfig:"APP_ID"`
}

type DomainImplementationType

type DomainImplementationType string

const (
	DomainImplementationTypeNone       DomainImplementationType = ""
	DomainImplementationTypeKubernetes DomainImplementationType = "kubernetes"
)

type GoogleTagManagerConfig

type GoogleTagManagerConfig struct {
	ContainerID string `envconfig:"CONTAINER_ID"`
}

type KubernetesConfig

type KubernetesConfig struct {
	// KubeConfig indicates the path to the `.kubeconfig` config file
	KubeConfig string `envconfig:"KUBERNETES_KUBECONFIG"`
	// AppNamespace indicates the namespace where the app's resources (e.g. ingress, cert) resides
	AppNamespace string `envconfig:"KUBERNETES_APP_NAMESPACE"`
}

type MailConfig

type MailConfig struct {
	Sender  string `envconfig:"SENDER"`
	ReplyTo string `envconfig:"REPLY_TO"`
}

type SMTPConfig

type SMTPConfig struct {
	Host     string          `envconfig:"HOST"`
	Port     int             `envconfig:"PORT"`
	Username string          `envconfig:"USERNAME"`
	Password string          `envconfig:"PASSWORD"`
	Mode     config.SMTPMode `envconfig:"MODE" default:"normal"`
}

type SearchConfig

type SearchConfig struct {
	Enabled bool `envconfig:"ENABLED" default:"false"`
}

type StripeConfig

type StripeConfig struct {
	// The key starting with "sk_"
	SecretKey string `envconfig:"SECRET_KEY"`

	// The key starting with "whsec_"
	WebhookSigningKey string `envconfig:"WEBHOOK_SIGNING_KEY"`
}

type Web3Config

type Web3Config struct {
	Enabled bool `envconfig:"ENABLED" default:"false"`
}