store

package

Go to main page

Versions in this module

v1

v1.5.0

Jun 16, 2026

Changes in this version

type LDAPConfig

+ GroupMappings []LDAPGroupMapping

+ type LDAPGroupMapping struct

+ GroupDN string

+ Sections []string

type Project

+ HostID int64

type Store

+ func (s *Store) EncryptPlaintextHostKeys(ctx context.Context) error

v1.4.4

Jun 15, 2026

v1.4.3

Jun 15, 2026

v1.4.2

Jun 15, 2026

v1.4.1

Jun 15, 2026

v1.4.0

Jun 15, 2026

Changes in this version

+ type APIToken struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID int64

+ LastUsedAt time.Time

+ Name string

+ ReadOnly bool

+ Revoked bool

+ Sections []string

+ TokenHash string

+ UserID int64

+ func (t *APIToken) Expired() bool

+ type APITokenWithUser struct

+ Username string

+ type ComposeFragment struct

+ Content string

+ CreatedAt time.Time

+ CreatedBy string

+ Description string

+ ID int64

+ Name string

+ Slug string

+ type OAuthClient struct

+ CreatedAt time.Time

+ ID string

+ Name string

+ RedirectURIs []string

+ type OAuthCode struct

+ ClientID string

+ CodeChallenge string

+ ExpiresAt time.Time

+ RedirectURI string

+ Resource string

+ Scope string

+ UserID int64

+ type OAuthRefreshToken struct

+ ClientID string

+ ExpiresAt time.Time

+ Resource string

+ Scope string

+ UserID int64

+ type ProjectTemplate struct

+ CreatedAt time.Time

+ CreatedBy string

+ Description string

+ ID int64

+ Name string

+ Slug string

+ type ServiceBlock struct

+ CreatedAt time.Time

+ CreatedBy string

+ Description string

+ ID int64

+ Name string

+ Service string

+ ServiceYAML string

+ Slug string

+ Volumes []string

type Store

+ func (s *Store) APITokenByHash(ctx context.Context, hash string) (*APIToken, error)

+ func (s *Store) AdminRevokeAPIToken(ctx context.Context, id int64) (bool, error)

+ func (s *Store) ComposeFragmentByID(ctx context.Context, id int64) (*ComposeFragment, error)

+ func (s *Store) ComposeFragmentBySlug(ctx context.Context, slug string) (*ComposeFragment, error)

+ func (s *Store) ConsumeOAuthCode(ctx context.Context, codeHash string) (*OAuthCode, error)

+ func (s *Store) ConsumeRefreshToken(ctx context.Context, tokenHash string) (*OAuthRefreshToken, error)

+ func (s *Store) CreateAPIToken(ctx context.Context, t *APIToken) (int64, error)

+ func (s *Store) CreateComposeFragment(ctx context.Context, f *ComposeFragment) (int64, error)

+ func (s *Store) CreateOAuthClient(ctx context.Context, c *OAuthClient) error

+ func (s *Store) CreateOAuthCode(ctx context.Context, codeHash string, c *OAuthCode) error

+ func (s *Store) CreateProjectTemplate(ctx context.Context, t *ProjectTemplate) (int64, error)

+ func (s *Store) CreateRefreshToken(ctx context.Context, tokenHash string, t *OAuthRefreshToken) error

+ func (s *Store) CreateServiceBlock(ctx context.Context, b *ServiceBlock) (int64, error)

+ func (s *Store) DeleteComposeFragment(ctx context.Context, id int64) error

+ func (s *Store) DeleteExpiredOAuth(ctx context.Context) error

+ func (s *Store) DeleteOAuthClient(ctx context.Context, id string) (bool, error)

+ func (s *Store) DeleteProjectTemplate(ctx context.Context, id int64) error

+ func (s *Store) DeleteServiceBlock(ctx context.Context, id int64) error

+ func (s *Store) ListAPITokens(ctx context.Context, userID int64) ([]APIToken, error)

+ func (s *Store) ListAllAPITokens(ctx context.Context) ([]APITokenWithUser, error)

+ func (s *Store) ListComposeFragments(ctx context.Context) ([]ComposeFragment, error)

+ func (s *Store) ListOAuthClients(ctx context.Context) ([]OAuthClient, error)

+ func (s *Store) ListProjectTemplates(ctx context.Context) ([]ProjectTemplate, error)

+ func (s *Store) ListServiceBlocks(ctx context.Context) ([]ServiceBlock, error)

+ func (s *Store) OAuthClientByID(ctx context.Context, id string) (*OAuthClient, error)

+ func (s *Store) ProjectTemplateByID(ctx context.Context, id int64) (*ProjectTemplate, error)

+ func (s *Store) ProjectTemplateBySlug(ctx context.Context, slug string) (*ProjectTemplate, error)

+ func (s *Store) RevokeAPIToken(ctx context.Context, id, userID int64) (bool, error)

+ func (s *Store) ServiceBlockByID(ctx context.Context, id int64) (*ServiceBlock, error)

+ func (s *Store) ServiceBlockBySlug(ctx context.Context, slug string) (*ServiceBlock, error)

+ func (s *Store) TouchAPIToken(ctx context.Context, id int64) error

+ func (s *Store) UpdateComposeFragment(ctx context.Context, f *ComposeFragment) error

+ func (s *Store) UpdateProjectTemplate(ctx context.Context, id int64, name, description string) error

+ func (s *Store) UpdateServiceBlock(ctx context.Context, b *ServiceBlock) error

v1.3.0

Jun 8, 2026

v1.2.0

Jun 5, 2026

Changes in this version

+ var ErrDuplicate = errors.New("store: duplicate")

type Host

+ Disabled bool

+ type Project struct

+ ComposeFile string

+ CreatedAt time.Time

+ CreatedBy string

+ ID int64

+ Name string

+ Slug string

+ UpdatedAt time.Time

type Store

+ func (s *Store) CreateProject(ctx context.Context, p *Project) (int64, error)

+ func (s *Store) DeleteProject(ctx context.Context, id int64) error

+ func (s *Store) ListProjects(ctx context.Context) ([]Project, error)

+ func (s *Store) ProjectByID(ctx context.Context, id int64) (*Project, error)

+ func (s *Store) SetHostDisabled(ctx context.Context, id int64, disabled bool) error

+ func (s *Store) TouchProject(ctx context.Context, id int64) error

+ func (s *Store) UpdateProjectName(ctx context.Context, id int64, name string) error

v1.1.0

Jun 4, 2026

Changes in this version

type Store

+ func (s *Store) Ping(ctx context.Context) error

+ func (s *Store) SetUserPrefs(ctx context.Context, userID int64, prefs string) error

+ func (s *Store) UserPrefs(ctx context.Context, userID int64) (string, error)

v1.0.0

Jun 2, 2026

Changes in this version

+ var ErrNotFound = errors.New("store: not found")

+ var Sections = []string

+ func NormalizeRegistryHost(host string) string

+ func ValidSection(key string) bool

+ type AlertEvent struct

+ Acknowledged bool

+ ContainerID string

+ ContainerName string

+ CreatedAt time.Time

+ HostID int64

+ HostName string

+ ID int64

+ Message string

+ RuleID int64

+ RuleName string

+ Severity string

+ Type string

+ Value *float64

+ type AlertRule struct

+ Config string

+ CooldownSec int

+ CreatedAt time.Time

+ Email bool

+ Enabled bool

+ ID int64

+ Name string

+ Severity string

+ Target string

+ Type string

+ WebhookID *int64

+ type AuditEntry struct

+ Action string

+ CreatedAt time.Time

+ Detail string

+ ID int64

+ IP string

+ Target string

+ UserID int64

+ Username string

+ type Host struct

+ Address string

+ AlertEmail string

+ CreatedAt time.Time

+ HostKey string

+ ID int64

+ Kind string

+ Name string

+ TLSCA string

+ TLSCert string

+ TLSKey string

+ type LDAPConfig struct

+ AdminGroupDN string

+ BindDN string

+ BindPassword string

+ Enabled bool

+ StartTLS bool

+ URL string

+ UserBaseDN string

+ UserFilter string

+ func (c LDAPConfig) Configured() bool

+ type ParseRule struct

+ CreatedAt time.Time

+ ID int64

+ Name string

+ Pattern string

+ type Registry struct

+ Address string

+ CreatedAt time.Time

+ ID int64

+ Name string

+ Username string

+ type RegistryAuth struct

+ Address string

+ Password string

+ Username string

+ type SMTPConfig struct

+ From string

+ Host string

+ Password string

+ Port int

+ TLS bool

+ To string

+ Username string

+ func (c SMTPConfig) Configured() bool

+ type Store struct

+ func Open(path string) (*Store, error)

+ func (s *Store) AckAlertEvent(ctx context.Context, id int64) error

+ func (s *Store) Audit(ctx context.Context, e AuditEntry) error

+ func (s *Store) AuthByID(ctx context.Context, id int64) (*RegistryAuth, error)

+ func (s *Store) AuthForHost(ctx context.Context, host string) (*RegistryAuth, error)

+ func (s *Store) Close() error

+ func (s *Store) CountAdmins(ctx context.Context) (int, error)

+ func (s *Store) CountUnacknowledged(ctx context.Context) (int, error)

+ func (s *Store) CountUsers(ctx context.Context) (int, error)

+ func (s *Store) CreateAlertRule(ctx context.Context, r *AlertRule) (int64, error)

+ func (s *Store) CreateHost(ctx context.Context, h *Host) (int64, error)

+ func (s *Store) CreateParseRule(ctx context.Context, name, pattern string) (int64, error)

+ func (s *Store) CreateRegistry(ctx context.Context, name, address, username, secret string) (int64, error)

+ func (s *Store) CreateUser(ctx context.Context, u *User) (int64, error)

+ func (s *Store) CreateWebhook(ctx context.Context, w *Webhook) (int64, error)

+ func (s *Store) DeleteAlertRule(ctx context.Context, id int64) error

+ func (s *Store) DeleteHost(ctx context.Context, id int64) error

+ func (s *Store) DeleteParseRule(ctx context.Context, id int64) error

+ func (s *Store) DeleteRegistry(ctx context.Context, id int64) error

+ func (s *Store) DeleteUser(ctx context.Context, id int64) error

+ func (s *Store) DeleteWebhook(ctx context.Context, id int64) error

+ func (s *Store) DisabledSections(ctx context.Context) ([]string, error)

+ func (s *Store) EnsureLocalHost(ctx context.Context) error

+ func (s *Store) GetLDAP(ctx context.Context) (LDAPConfig, error)

+ func (s *Store) GetSMTP(ctx context.Context) (SMTPConfig, error)

+ func (s *Store) HostByID(ctx context.Context, id int64) (*Host, error)

+ func (s *Store) InsertAlertEvent(ctx context.Context, e *AlertEvent) (int64, error)

+ func (s *Store) ListAlertEvents(ctx context.Context, limit int) ([]AlertEvent, error)

+ func (s *Store) ListAlertRules(ctx context.Context) ([]AlertRule, error)

+ func (s *Store) ListHosts(ctx context.Context) ([]Host, error)

+ func (s *Store) ListParseRules(ctx context.Context) ([]ParseRule, error)

+ func (s *Store) ListRegistries(ctx context.Context) ([]Registry, error)

+ func (s *Store) ListUsers(ctx context.Context) ([]User, error)

+ func (s *Store) ListWebhooks(ctx context.Context) ([]Webhook, error)

+ func (s *Store) LocalhostNo2FA(ctx context.Context) (bool, error)

+ func (s *Store) RecentAudit(ctx context.Context, limit int) ([]AuditEntry, error)

+ func (s *Store) SetAlertRuleEnabled(ctx context.Context, id int64, enabled bool) error

+ func (s *Store) SetCipher(c *crypto.Cipher)

+ func (s *Store) SetDisabledSections(ctx context.Context, keys []string) error

+ func (s *Store) SetHostAlertEmail(ctx context.Context, id int64, email string) error

+ func (s *Store) SetHostKey(ctx context.Context, id int64, key string) error

+ func (s *Store) SetLDAP(ctx context.Context, c LDAPConfig) error

+ func (s *Store) SetLocalhostNo2FA(ctx context.Context, on bool) error

+ func (s *Store) SetSMTP(ctx context.Context, c SMTPConfig) error

+ func (s *Store) SetSetting(ctx context.Context, key, value string) error

+ func (s *Store) SetTOTP(ctx context.Context, userID int64, secret string, enabled bool) error

+ func (s *Store) Setting(ctx context.Context, key string) (string, error)

+ func (s *Store) TouchLogin(ctx context.Context, userID int64) error

+ func (s *Store) UpdateAlertRule(ctx context.Context, id int64, r *AlertRule) error

+ func (s *Store) UpdatePassword(ctx context.Context, userID int64, hash string) error

+ func (s *Store) UpdateUserAccess(ctx context.Context, id int64, role string, readOnly bool, sections []string) error

+ func (s *Store) UserByID(ctx context.Context, id int64) (*User, error)

+ func (s *Store) UserByUsername(ctx context.Context, username string) (*User, error)

+ func (s *Store) WebhookByID(ctx context.Context, id int64) (*Webhook, error)

+ type User struct

+ AuthSource string

+ CreatedAt time.Time

+ ID int64

+ LastLoginAt time.Time

+ PasswordHash string

+ ReadOnly bool

+ Role string

+ Sections []string

+ TOTPEnabled bool

+ TOTPSecret string

+ Username string

+ func (u *User) IsAdmin() bool

+ type Webhook struct

+ BodyTemplate string

+ CreatedAt time.Time

+ Headers map[string]string

+ ID int64

+ Method string

+ Name string

+ URL string

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