setup

Oct 6, 2026

Changes in this version

+ const EngineHTTP

Sep 21, 2026

Changes in this version

+ const KeyServerReadOnly

type ServerConfig

+ ReadOnly bool

Sep 17, 2026

Changes in this version

+ func ApplyTelemetryChange(dirs paths.Dirs, change telemetry.Change, channel telemetry.Channel, ...) (telemetry.Consent, bool, error)

+ func TelemetryConfirmationRequired() *envelope.Error

type Config

+ Telemetry telemetry.Consent

type Status

+ Telemetry StatusTelemetry

+ func (s *Status) SetTelemetry(d telemetry.Decision, available bool)

+ type StatusTelemetry struct

+ Reason string

+ ReasonText string

+ Sending bool

+ State string

+ type TelemetryOutcome struct

+ Backup string

+ Changed bool

+ Consent telemetry.Consent

+ func ChangeTelemetry(dirs paths.Dirs, change telemetry.Change, channel telemetry.Channel, ...) (TelemetryOutcome, error)

Sep 17, 2026

Changes in this version

+ func BootstrapNext() []envelope.Next

type Status

+ Skills []skills.Installed

+ func (s *Status) SetSkills(installed []skills.Installed)

Sep 17, 2026

Changes in this version

+ const ActionEditManifest

+ const GitIdentityMissingCode

+ const InGitDBDir

+ func ConnectedNext(database Database, gitIdentityMissing bool) []envelope.Next

+ func ConnectedStored(database Database) string

+ func EnvironmentNames(m *manifest.Manifest) []string

+ func EnvironmentValues(m *manifest.Manifest, getenv func(string) string) []string

+ func GitIdentityMissing(ctx context.Context, dir string) bool

+ func GitIdentityNext() []envelope.Next

+ func ValidateConnect(request *ConnectRequest) *envelope.Error

+ type ConnectRequest struct

+ Engine string

+ ID string

+ Manifest string

+ Path string

type Registry

+ func (r *Registry) Connect(request ConnectRequest) (DatabaseResult, error)

+ func (r *Registry) GitStorage(id string) (string, bool)

type RegistryOptions

+ Getenv func(string) string

Sep 17, 2026

Changes in this version

+ const ScopeCreateDB

+ const ScopeReadOnly

+ const ScopeReadWrite

+ func HasCreateDBCapability(caps []string) bool

+ func ScopeCapabilities(scope string) ([]string, error)

Sep 17, 2026

Changes in this version

+ const DemoDefaultID

+ const DemosDir

+ const DemosFile

+ func DemoLocation(dataHome, id string) string

+ func ForgetDemo(home, id string) error

+ func RecordDemo(home string, record DemoRecord) error

+ func SameLocation(a, b string) bool

type Database

+ func FindDemo(home string, databases []Database) (Database, bool)

+ type DemoRecord struct

+ App string

+ Database string

+ Location string

+ func DemoRecordFor(home, location string) (DemoRecord, bool)

+ func ReadDemos(home string) []DemoRecord

+ type DemoStatus struct

+ Database string

+ Installed bool

+ Location string

+ func NewDemoStatus(dirs paths.Dirs, databases []Database) DemoStatus

type Registry

+ func (r *Registry) AwaitMount(ctx context.Context, id string)

+ func (r *Registry) Reconnect(request CreateRequest) (DatabaseResult, error)

type Status

+ Demo DemoStatus

Sep 17, 2026

Changes in this version

+ const ActionBrowse

+ const ActionDatabases

+ const ActionDone

+ const ActionEditLocation

+ const ActionEditName

+ const ActionUse

+ const CataloguesDir

+ const DatabasesDir

+ const DefaultMountTimeout

+ const EngineFirestore

+ const EngineInGitDB

+ const EngineMySQL

+ const EnginePostgres

+ const EngineSQLite

+ const ManifestDocsURL

+ const MountMounted

+ const MountMounting

+ const MountNeedsAttention

+ const MountUnknown

+ const MountsFile

+ const SchemaDocsURL

+ const SetupGuided

+ const SetupManifest

+ const UnmountTimeout

+ func CatalogueDir(home string) string

+ func CreatedNext(database Database) []envelope.Next

+ func DatabaseIDs(databases []Database) []string

+ func DefaultPath(dataHome, engine, id string) string

+ func Location(m *manifest.Manifest, baseDir string) string

+ func ManifestPath(home, id string) string

+ func ManifestSteps(engine, home string) []envelope.Next

+ func MountsPath(runtimeDir string) string

+ func RegistryDir(home string) string

+ func ReloadedNext(database Database) []envelope.Next

+ func SuggestedName(next envelope.Next) string

+ func ValidateCreate(request *CreateRequest) *envelope.Error

+ func WriteMounts(runtimeDir string, mounts Mounts) error

type CopyRef

+ func ContextStatus(context *dbcontext.Context) CopyRef

+ func DatabasesStatus(databases []Database) CopyRef

+ func StatusLine(server Server, databases []Database, context *dbcontext.Context) []CopyRef

+ type CreateRequest struct

+ Engine string

+ ID string

+ Path string

+ type Database struct

+ Engine string

+ ID string

+ Location string

+ Manifest string

+ Reason string

+ State string

+ func ListDatabases(home string, mounts *Mounts) ([]Database, error)

+ type DatabaseResult struct

+ Database Database

+ Next []envelope.Next

+ Schema int

+ func NewRemovedResult(database Database) DatabaseResult

+ type DatabasesDocument struct

+ Databases []Database

+ Next []envelope.Next

+ Schema int

+ func NewDatabasesDocument(databases []Database) DatabasesDocument

+ type Engine struct

+ Description string

+ ID string

+ ManifestSteps []envelope.Next

+ Name string

+ Note string

+ Pinned bool

+ SchemaModes []string

+ Setup string

+ func Engines() []Engine

+ func FilterEngines(engines []Engine, filter string) []Engine

+ func FindEngine(id string) (Engine, bool)

+ type EnginesDocument struct

+ Engines []Engine

+ Next []envelope.Next

+ Schema int

+ func NewEnginesDocument(home string) EnginesDocument

type HomeOption

+ Disabled bool

+ type MountRecord struct

+ ID string

+ Manifest string

+ Reason string

+ State string

+ type Mounter interface

+ Mount func(db *core.Database) error

+ UnmountContext func(ctx context.Context, id string) error

+ type Mounts struct

+ Databases []MountRecord

+ Schema int

+ func ReadMounts(runtimeDir string) (*Mounts, error)

+ type Registration struct

+ Err error

+ ID string

+ Manifest string

+ Parsed *manifest.Manifest

+ func ReadRegistry(home string) ([]Registration, error)

+ func (r Registration) Describe() Database

+ type Registry struct

+ func OpenRegistry(dirs paths.Dirs, srv Mounter, logf func(format string, args ...any), ...) (*Registry, error)

+ func (r *Registry) Close()

+ func (r *Registry) Create(request CreateRequest) (DatabaseResult, error)

+ func (r *Registry) List() ([]Database, error)

+ func (r *Registry) MountAll(ctx context.Context)

+ func (r *Registry) Mounts() *Mounts

+ func (r *Registry) Reload(ctx context.Context, id string) (DatabaseResult, error)

+ func (r *Registry) ReloadAll(ctx context.Context) (DatabasesDocument, error)

+ func (r *Registry) Remove(ctx context.Context, id string) (DatabaseResult, error)

+ type RegistryOptions struct

+ MountTimeout time.Duration

type Status

+ Context *dbcontext.Context

+ Databases []Database

Sep 17, 2026

Changes in this version

+ const MaxPort

+ const MinPort

+ func ValidPort(port int) bool

Sep 17, 2026

Changes in this version

+ const KeyServerCORS

+ var Keys = []string

+ func NormalizeOrigins(origins []string) []string

+ func ParseOrigins(value string) ([]string, *envelope.Error)

+ type Badge struct

+ LabelKey string

+ Tone string

+ func StateBadge(state string) Badge

type ConfigDocument

+ Changed *bool

+ type CopyRef struct

+ Key string

+ Params map[string]string

+ type HomeDocument struct

+ Options []HomeOption

+ QuestionKey string

+ Schema int

+ StatusLine []CopyRef

+ func NewHome(server Server) HomeDocument

+ type HomeOption struct

+ Badge *Badge

+ DescriptionKey string

+ Group string

+ ID string

+ LabelKey string

+ WebLabelKey string

type ServerConfig

+ CORS []string

type ServerDocument

+ Next []envelope.Next

Sep 17, 2026

Changes in this version

+ const ConfigFile

+ const EnvPort

+ const KeyServerPort

+ const StateNotRunning

+ const StateRunning

+ const StateStopping

+ func FallbackAddress(port int) string

+ func ParsePort(value, source string) (int, *envelope.Error)

+ func PrimaryAddress(port int) string

+ func ResolvePort(flagPort int, getenv paths.Getenv, config Config) (port int, explicit bool, err *envelope.Error)

+ func UnknownConfigKey(key string) *envelope.Error

+ type Config struct

+ Server ServerConfig

+ func LoadConfig(home string) (Config, error)

+ type ConfigChange struct

+ Key string

+ Value string

+ type ConfigDocument struct

+ Config Config

+ Next []envelope.Next

+ Schema int

+ func ApplyConfigChange(dirs paths.Dirs, change ConfigChange, serverRunning bool) (ConfigDocument, error)

+ func NewConfigDocument(config Config, changedWhileRunning bool) ConfigDocument

+ type Server struct

+ Address string

+ FallbackAddress string

+ Log string

+ PID int

+ Port int

+ StartedAt *time.Time

+ State string

+ Version string

+ func RunningServer(record *runtime.Record, dirs paths.Dirs) Server

+ func StoppedServer(port int, dirs paths.Dirs) Server

+ type ServerConfig struct

+ Port int

+ type ServerDocument struct

+ Schema int

+ Server Server

+ func NewServerDocument(server Server) ServerDocument

+ type Status struct

+ Locations paths.Dirs

+ Next []envelope.Next

+ Schema int

+ Server Server

+ Version string

+ func NewStatus(version string, dirs paths.Dirs, server Server) Status