entconfig

package
v1.11.21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 11, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package entconfig holds configuration stuff for the ent server

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Billing added in v0.41.1

type Billing struct {
	// RequirePaymentMethod indicates whether to check if a payment method
	// exists for orgs before they can access some resource
	RequirePaymentMethod bool `json:"requirepaymentmethod" koanf:"requirepaymentmethod"`
	// BypassEmailDomains is a list of domains that should be allowed to bypass
	// the checks if RequirePaymentMethod above is enabled
	BypassEmailDomains []string `json:"bypassemaildomains" koanf:"bypassemaildomains"`
}

Billing settings for feature access

type Config

type Config struct {
	// EntityTypes is the list of entity types to create by default for the organization
	EntityTypes []string `json:"entitytypes" koanf:"entitytypes" default:"" description:"entity types to create for the organization"`
	// Summarizer contains configuration for text summarization
	Summarizer summarizer.Config `json:"summarizer" koanf:"summarizer"`
	// MaxPoolSize is the max worker pool size that can be used by the ent client
	MaxPoolSize int `json:"maxpoolsize" koanf:"maxpoolsize" default:"200"`
	// Modules contains the configuration for the module system
	Modules Modules `json:"modules" koanf:"modules"`
	// MaxSchemaImportSize is the maximum size allowed for schema imports in bytes
	MaxSchemaImportSize int `` /* 133-byte string literal not displayed */
	// EmailValidation contains configuration for email validation
	EmailValidation validator.EmailVerificationConfig `json:"emailvalidation" koanf:"emailvalidation"`
	// Billing contains configuration for billing related features
	Billing Billing `json:"billing" koanf:"billing"`
	// Notifications contains configuration for notifications sent to users based on events
	Notifications Notifications `json:"notifications" koanf:"notifications"`
}

Config holds the configuration for the ent server

type Modules added in v0.28.0

type Modules struct {
	// Enabled indicates whether to check and verify module access
	Enabled bool `json:"enabled" koanf:"enabled" default:"true"`
	// UseSandbox indicates whether to use the sandbox catalog for module access checks
	UseSandbox bool `json:"usesandbox" koanf:"usesandbox" default:"false"`
	// DevMode enables all modules for local development regardless of trial status
	DevMode bool `json:"devmode" koanf:"devmode" default:"false"`
}

Modules settings for features access

type Notifications added in v0.48.1

type Notifications struct {
	// ConsoleURL for ui links used in notifications
	ConsoleURL string `koanf:"consoleurl" json:"consoleurl" default:"http://localhost:3001" domain:"inherit" domainPrefix:"https://console"`
}

Notifications settings for notifications sent to users based on events

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL