startup

package

v1.19.2 Latest Latest Go to latest Published: May 17, 2026 License: BSD-3-Clause Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/getarcaneapp/arcane

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

func ApplyRequestedRuntimeIdentity(ctx context.Context, cfg *RuntimeIdentityConfig) error
func CleanupUnknownSettings(ctx context.Context, settingsMgr SettingsPruner)
func EnsureEncryptionKey(ctx context.Context, cfg *RuntimeConfig, ...)
func InitializeAutoLogin(ctx context.Context, cfg *RuntimeConfig)
func InitializeDefaultSettings(ctx context.Context, cfg *RuntimeConfig, settingsMgr SettingsManager)
func InitializeNonAgentFeatures(ctx context.Context, cfg *RuntimeConfig, ...)
func LoadAgentToken(ctx context.Context, cfg *RuntimeConfig, ...)
func MigrateGitOpsSyncIntervals(ctx context.Context, ...)
func MigrateSchedulerCronValues(ctx context.Context, ...)
func TestDockerConnection(ctx context.Context, testFunc func(context.Context) error)
type IntervalMigrationItem
type RuntimeConfig
type RuntimeIdentityConfig
type SettingsManager
type SettingsPruner

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ApplyRequestedRuntimeIdentity ¶

func ApplyRequestedRuntimeIdentity(ctx context.Context, cfg *RuntimeIdentityConfig) error

ApplyRequestedRuntimeIdentity switches the current process to the configured runtime UID/GID before the rest of the app initializes.

func CleanupUnknownSettings ¶

func CleanupUnknownSettings(ctx context.Context, settingsMgr SettingsPruner)

func EnsureEncryptionKey ¶

func EnsureEncryptionKey(ctx context.Context, cfg *RuntimeConfig, ensureKeyFunc func(context.Context) (string, error))

func InitializeAutoLogin ¶

func InitializeAutoLogin(ctx context.Context, cfg *RuntimeConfig)

func InitializeDefaultSettings ¶

func InitializeDefaultSettings(ctx context.Context, cfg *RuntimeConfig, settingsMgr SettingsManager)

func InitializeNonAgentFeatures ¶

func InitializeNonAgentFeatures(
	ctx context.Context,
	cfg *RuntimeConfig,
	createAdminFunc func(context.Context) error,
	reconcileDefaultAdminAPIKeyFunc func(context.Context) error,
	autoLoginInitFunc func(context.Context) error,
	migrateOidcFunc func(context.Context) error,
	migrateDiscordFunc func(context.Context) error,
)

func LoadAgentToken ¶

func LoadAgentToken(ctx context.Context, cfg *RuntimeConfig, getSettingFunc func(context.Context, string, string) string)

func MigrateGitOpsSyncIntervals ¶

func MigrateGitOpsSyncIntervals(
	ctx context.Context,
	listFunc func(context.Context) ([]IntervalMigrationItem, error),
	updateFunc func(context.Context, string, int) error,
)

func MigrateSchedulerCronValues ¶

func MigrateSchedulerCronValues(
	ctx context.Context,
	getSettingFunc func(context.Context, string, string) string,
	updateSettingFunc func(context.Context, string, string) error,
	reloadFunc func(context.Context) error,
)

func TestDockerConnection ¶

func TestDockerConnection(ctx context.Context, testFunc func(context.Context) error)

Types ¶

type IntervalMigrationItem ¶

type IntervalMigrationItem struct {
	ID       string
	RawValue string
}

type RuntimeConfig ¶

type RuntimeConfig struct {
	AgentMode         bool
	AgentToken        string
	Environment       string
	EncryptionKey     string
	AutoLoginUsername string
	AdminStaticAPIKey string
}

type RuntimeIdentityConfig ¶ added in v1.19.0

type RuntimeIdentityConfig struct {
	PUID         string
	PGID         string
	DockerHost   string
	DockerConfig string
	DatabaseURL  string
}

RuntimeIdentityConfig contains the config-backed environment values used to switch the process runtime identity before the application initializes.

type SettingsManager ¶

type SettingsManager interface {
	PersistEnvSettingsIfMissing(ctx context.Context) error
	SetBoolSetting(ctx context.Context, key string, value bool) error
	EnsureDefaultSettings(ctx context.Context) error
}

type SettingsPruner ¶

type SettingsPruner interface {
	PruneUnknownSettings(ctx context.Context) error
}

Source Files ¶

View all Source files

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