types

Feb 24, 2026

Changes in this version

+ var ErrAlreadyRunning = errors.New("service is already running")

+ var ErrAlreadyStopped = errors.New("service is already stopped")

+ var ErrCatalogNotFound = errors.New("catalog not found")

+ var ErrConfigNotFound = errors.New("configuration not found")

+ var ErrContainerFailed = errors.New("container failed")

+ var ErrContainerNotFound = errors.New("container not found")

+ var ErrInvalidCatalog = errors.New("invalid catalog format")

+ var ErrInvalidConfig = errors.New("invalid configuration")

+ var ErrInvalidProject = errors.New("invalid project configuration")

+ var ErrInvalidService = errors.New("invalid service configuration")

+ var ErrNetworkFailed = errors.New("network operation failed")

+ var ErrNetworkNotFound = errors.New("network not found")

+ var ErrNotInitialized = errors.New("doku is not initialized")

+ var ErrProjectExists = errors.New("project already exists")

+ var ErrProjectNotFound = errors.New("project not found")

+ var ErrServiceNotFound = errors.New("service not found")

+ var ErrServiceNotRunning = errors.New("service is not running")

+ var ErrVersionNotFound = errors.New("version not found")

+ var ErrVolumeFailed = errors.New("volume operation failed")

+ var ErrVolumeNotFound = errors.New("volume not found")

+ type InitContainer struct

+ Command []string

+ DependsOn []string

+ Environment map[string]string

+ Image string

+ Name string

type Instance

+ HealthStatus string

type NetworkConfig

+ PortMappings map[string]string

type Project

+ ContainerID string

type ServiceSpec

+ InitContainers []InitContainer

Nov 3, 2025

Changes in this version

+ type CatalogService struct

+ Category string

+ Description string

+ Icon string

+ Links *ServiceLinks

+ Name string

+ Tags []string

+ Versions map[string]*ServiceSpec

+ type CertificatesConfig struct

+ CACert string

+ CAKey string

+ CertsDir string

+ type Config struct

+ Certificates CertificatesConfig

+ Instances map[string]*Instance

+ Monitoring MonitoringConfig

+ Network NetworkGlobalConfig

+ Preferences PreferencesConfig

+ Projects map[string]*Project

+ Traefik TraefikGlobalConfig

+ type ConfigOption struct

+ Default string

+ Description string

+ EnvVar string

+ Name string

+ Options []string

+ Required bool

+ Type string

+ Validation string

+ type ConnectionInfo struct

+ Env map[string]string

+ Host string

+ Port int

+ Protocol string

+ URL string

+ type ContainerInfo struct

+ ContainerID string

+ FullName string

+ Image string

+ Name string

+ Ports []string

+ Primary bool

+ Status string

+ type ContainerSpec struct

+ Command []string

+ DependsOn []string

+ Entrypoint []string

+ Environment map[string]string

+ Healthcheck *Healthcheck

+ Image string

+ Name string

+ Ports []string

+ Primary bool

+ Resources *ResourceRequirements

+ Volumes []string

+ type DependencySpec struct

+ Environment map[string]string

+ Name string

+ Required bool

+ Version string

+ type DiscoveryConfig struct

+ CompatibleWith []string

+ ConnectionTemplate string

+ DefaultPort int

+ EnvVars map[string]string

+ Protocol string

+ Type string

+ type DockerConfig struct

+ DefaultTag string

+ Environment []EnvVar

+ HealthCheck *HealthCheck

+ Image string

+ Ports []PortConfig

+ Volumes []VolumeConfig

+ type EnvVar struct

+ Default string

+ Description string

+ Key string

+ Prompt string

+ Required bool

+ type HealthCheck struct

+ Interval string

+ Retries int

+ Test []string

+ Timeout string

+ type Healthcheck struct

+ Interval string

+ Retries int

+ Start string

+ Test []string

+ Timeout string

+ type Instance struct

+ ConnectionString string

+ ContainerID string

+ ContainerName string

+ Containers []ContainerInfo

+ CreatedAt time.Time

+ Dependencies []string

+ Environment map[string]string

+ IsMultiContainer bool

+ Name string

+ Network NetworkConfig

+ Resources ResourceConfig

+ ServiceType string

+ Status ServiceStatus

+ Traefik TraefikInstanceConfig

+ URL string

+ UpdatedAt time.Time

+ Version string

+ Volumes map[string]string

+ func (i *Instance) ContainerCount() int

+ func (i *Instance) GetAllContainerIDs() []string

+ func (i *Instance) GetContainerByName(name string) *ContainerInfo

+ func (i *Instance) GetMainContainerID() string

+ func (i *Instance) GetMainContainerName() string

+ func (i *Instance) GetPrimaryContainer() *ContainerInfo

+ func (i *Instance) HasDependencies() bool

+ type MonitoringConfig struct

+ APIKey string

+ DSN string

+ Enabled bool

+ InstallTime time.Time

+ Tool string

+ URL string

+ type NetworkConfig struct

+ HostPort int

+ InternalPort int

+ Name string

+ type NetworkGlobalConfig struct

+ Gateway string

+ Name string

+ Subnet string

+ type PortConfig struct

+ Container int

+ Description string

+ ExposeToHost bool

+ HostDefault int

+ type PreferencesConfig struct

+ CatalogVersion string

+ DNSSetup string

+ Domain string

+ LastUpdate time.Time

+ Protocol string

+ type Project struct

+ ContainerName string

+ CreatedAt time.Time

+ Dependencies []string

+ Dockerfile string

+ Environment map[string]string

+ Name string

+ Path string

+ Port int

+ Status ServiceStatus

+ URL string

+ type ResourceConfig struct

+ CPULimit string

+ CPUUsage string

+ MemoryLimit string

+ MemoryUsage string

+ type ResourceRequirements struct

+ CPUMax string

+ CPUMin string

+ MemoryMax string

+ MemoryMin string

+ type Service struct

+ Category string

+ Description string

+ Discovery DiscoveryConfig

+ DisplayName string

+ Docker DockerConfig

+ Icon string

+ Name string

+ OfficialDocs string

+ Tags []string

+ Traefik TraefikConfig

+ Versions VersionConfig

+ type ServiceCatalog struct

+ Services map[string]*CatalogService

+ Version string

+ type ServiceConfiguration struct

+ Options []ConfigOption

+ type ServiceLinks struct

+ Documentation string

+ Homepage string

+ Repository string

+ type ServiceSpec struct

+ AdminPort int

+ Command []string

+ Configuration *ServiceConfiguration

+ Containers []ContainerSpec

+ Dependencies []DependencySpec

+ Description string

+ Environment map[string]string

+ Healthcheck *Healthcheck

+ Image string

+ Port int

+ Ports []string

+ Protocol string

+ Resources *ResourceRequirements

+ Volumes []string

+ func (s *ServiceSpec) GetContainerByName(name string) *ContainerSpec

+ func (s *ServiceSpec) GetDependencyNames() []string

+ func (s *ServiceSpec) GetPrimaryContainer() *ContainerSpec

+ func (s *ServiceSpec) HasDependencies() bool

+ func (s *ServiceSpec) IsMultiContainer() bool

+ func (s *ServiceSpec) Validate() error

+ type ServiceStatus string

+ const StatusFailed

+ const StatusRunning

+ const StatusStopped

+ const StatusUnknown

+ type TraefikConfig struct

+ CustomRules []string

+ Enabled bool

+ HasWebInterface bool

+ Port int

+ WebPort int

+ type TraefikGlobalConfig struct

+ ContainerName string

+ DashboardEnabled bool

+ DashboardURL string

+ HTTPPort int

+ HTTPSPort int

+ Status ServiceStatus

+ type TraefikInstanceConfig struct

+ Enabled bool

+ Port int

+ Protocol string

+ Subdomain string

+ type ValidationError struct

+ Field string

+ Message string

+ func (e *ValidationError) Error() string

+ type VersionConfig struct

+ Default string

+ Deprecated []string

+ EOL []string

+ Supported []string

+ type VolumeConfig struct

+ ContainerPath string

+ Description string

+ HostPath string

+ Required bool