config

Documentation

Index

• type AWSS3ObjectStoreConfig
  • func (c *AWSS3ObjectStoreConfig) Initialize(ctx *validation.Context)
  • func (c *AWSS3ObjectStoreConfig) Validate(ctx *validation.Context)
• type AzureBlobStorageObjectStoreConfig
  • func (c *AzureBlobStorageObjectStoreConfig) Initialize(ctx *validation.Context)
  • func (c *AzureBlobStorageObjectStoreConfig) Validate(ctx *validation.Context)
• type EnvironmentConfig
• type GCPGCSObjectStoreConfig
  • func (c *GCPGCSObjectStoreConfig) Initialize(ctx *validation.Context)
  • func (c *GCPGCSObjectStoreConfig) Validate(ctx *validation.Context)
• type ImagesCDNHost
• type LogLevel
• type ObjectStoreConfig
  • func (c *ObjectStoreConfig) Initialize(ctx *validation.Context)
  • func (c *ObjectStoreConfig) Validate(ctx *validation.Context)
• type ObjectStoreType

Types

type AWSS3ObjectStoreConfig

type AWSS3ObjectStoreConfig struct {
	BucketName      string `envconfig:"BUCKET_NAME"`
	Region          string `envconfig:"REGION"`
	AccessKeyID     string `envconfig:"ACCESS_KEY_ID"`
	SecretAccessKey string `envconfig:"SECRET_ACCESS_KEY"`
}

func (*AWSS3ObjectStoreConfig) Initialize

func (c *AWSS3ObjectStoreConfig) Initialize(ctx *validation.Context)

func (*AWSS3ObjectStoreConfig) Validate

func (c *AWSS3ObjectStoreConfig) Validate(ctx *validation.Context)

type AzureBlobStorageObjectStoreConfig

type AzureBlobStorageObjectStoreConfig struct {
	StorageAccount string `envconfig:"STORAGE_ACCOUNT"`
	Container      string `envconfig:"CONTAINER"`
	// ServiceURL is custom Azure blob storage URL. Empty for default URL.
	ServiceURL string `envconfig:"SERVICE_URL"`
	// AccessKey is encoded in standard BASE64.
	AccessKey string `envconfig:"ACCESS_KEY"`
}

func (*AzureBlobStorageObjectStoreConfig) Initialize

func (c *AzureBlobStorageObjectStoreConfig) Initialize(ctx *validation.Context)

func (*AzureBlobStorageObjectStoreConfig) Validate

func (c *AzureBlobStorageObjectStoreConfig) Validate(ctx *validation.Context)

type EnvironmentConfig

type EnvironmentConfig struct {
	// TrustProxy sets whether HTTP headers from proxy are to be trusted
	TrustProxy config.TrustProxy `envconfig:"TRUST_PROXY" default:"false"`
	// LogLevel sets the global log level
	LogLevel LogLevel `envconfig:"LOG_LEVEL" default:"warn"`
	// SentryDSN sets the sentry DSN.
	SentryDSN config.SentryDSN `envconfig:"SENTRY_DSN"`
	// ConfigSource configures the source of app configurations
	ConfigSource *configsource.Config `envconfig:"CONFIG_SOURCE"`
	// 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"`
	// GlobalDatabase configures the global database for configuresource
	GlobalDatabase *config.GlobalDatabaseCredentialsEnvironmentConfig `envconfig:"DATABASE"`
	// DatabaseConfig configures the database connection config
	DatabaseConfig *config.DatabaseEnvironmentConfig `envconfig:"DATABASE_CONFIG"`

	ImagesCDNHost ImagesCDNHost `envconfig:"IMAGES_CDN_HOST"`
	// CORSAllowOrigins configures a comma-separated list of allowed origins for CORSMiddleware
	CORSAllowedOrigins config.CORSAllowedOrigins `envconfig:"CORS_ALLOWED_ORIGINS"`
}

type GCPGCSObjectStoreConfig

type GCPGCSObjectStoreConfig struct {
	BucketName          string `envconfig:"BUCKET_NAME"`
	ServiceAccount      string `envconfig:"SERVICE_ACCOUNT"`
	CredentialsJSONPath string `envconfig:"CREDENTIALS_JSON_PATH"`
	CredentialsJSON     []byte `ignored:"true"`
}

func (*GCPGCSObjectStoreConfig) Initialize

func (c *GCPGCSObjectStoreConfig) Initialize(ctx *validation.Context)

func (*GCPGCSObjectStoreConfig) Validate

func (c *GCPGCSObjectStoreConfig) Validate(ctx *validation.Context)

type ImagesCDNHost

type ImagesCDNHost string

type LogLevel

type LogLevel string

type ObjectStoreConfig

type ObjectStoreConfig struct {
	Type             ObjectStoreType                   `envconfig:"TYPE"`
	AWSS3            AWSS3ObjectStoreConfig            `envconfig:"AWS_S3"`
	GCPGCS           GCPGCSObjectStoreConfig           `envconfig:"GCP_GCS"`
	AzureBlobStorage AzureBlobStorageObjectStoreConfig `envconfig:"AZURE_BLOB_STORAGE"`
}

func (*ObjectStoreConfig) Initialize

func (c *ObjectStoreConfig) Initialize(ctx *validation.Context)

func (*ObjectStoreConfig) Validate

func (c *ObjectStoreConfig) Validate(ctx *validation.Context)

type ObjectStoreType

type ObjectStoreType string

const (
	ObjectStoreTypeAWSS3            ObjectStoreType = "AWS_S3"
	ObjectStoreTypeGCPGCS           ObjectStoreType = "GCP_GCS"
	ObjectStoreTypeAzureBlobStorage ObjectStoreType = "AZURE_BLOB_STORAGE"
)