internal/

directory
v1.10.26 Latest Latest
Warning

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

Go to latest
Published: Nov 10, 2026 License: AGPL-3.0

Directories

Path Synopsis
Package acme issues TLS certificates via ACME DNS-01 using caller-supplied solver funcs.
Package acme issues TLS certificates via ACME DNS-01 using caller-supplied solver funcs.
Package components lists the independently versioned parts of Miabi for the About page.
Package components lists the independently versioned parts of Miabi for the About page.
Package cron is a recurring-task scheduler keyed by "kind:id" strings so sources share one loop without collisions.
Package cron is a recurring-task scheduler keyed by "kind:id" strings so sources share one loop without collisions.
Package datavolume refuses to start a workload whose volume is gone, since Docker would silently create an empty one.
Package datavolume refuses to start a workload whose volume is gone, since Docker would silently create an empty one.
Package dbenvelope seals per-set data keys under the backup passphrase so the passphrase is cheaply rotatable.
Package dbenvelope seals per-set data keys under the backup passphrase so the passphrase is cheaply rotatable.
Package declarative is the miabi.io/v1 resource model shared by apply, GitOps, Terraform and marketplace templates.
Package declarative is the miabi.io/v1 resource model shared by apply, GitOps, Terraform and marketplace templates.
Package dns wraps libdns behind one Provider interface; Miabi only manages the records it owns.
Package dns wraps libdns behind one Provider interface; Miabi only manages the records it owns.
Package dnscatalog is the single source of truth for supported DNS hosts: validation, secrets, API enum and UI form.
Package dnscatalog is the single source of truth for supported DNS hosts: validation, secrets, API enum and UI form.
gen command
Command gen prints the docs' supported-providers table so it cannot drift from the catalog.
Command gen prints the docs' supported-providers table so it cannot drift from the catalog.
Package docker is the sole adapter over the Docker SDK, keeping SDK types out of the rest of the codebase.
Package docker is the sole adapter over the Docker SDK, keeping SDK types out of the rest of the codebase.
Package dr holds disaster-recovery primitives and depends on nothing else in Miabi: restore runs on a bare host.
Package dr holds disaster-recovery primitives and depends on nothing else in Miabi: restore runs on a bare host.
Package drift is the shared vocabulary for divergence between Miabi's records and what Docker runs.
Package drift is the shared vocabulary for divergence between Miabi's records and what Docker runs.
Package healthprobe embeds the probe binary; without bin/ (make build-probe) builds fall back to a shell probe.
Package healthprobe embeds the probe binary; without bin/ (make build-probe) builds fall back to a shell probe.
Package hostmount defines the allow-listed host bind mounts; sources are server-owned, never client-supplied.
Package hostmount defines the allow-listed host bind mounts; sources are server-owned, never client-supplied.
Package hoststats re-exports pkg/hoststats and adds the control-plane-only helper-container sampler.
Package hoststats re-exports pkg/hoststats and adds the control-plane-only helper-container sampler.
Package leader elects the process that runs singleton work; it is not multi-replica HA.
Package leader elects the process that runs singleton work; it is not multi-replica HA.
Package logstore externalizes finished logs to gzipped objects; a nil *Store is a no-op.
Package logstore externalizes finished logs to gzipped objects; a nil *Store is a no-op.
Package mwcatalog is the source of truth for curated Goma middleware types exposed as security policies.
Package mwcatalog is the source of truth for curated Goma middleware types exposed as security policies.
Package netguard checks the resolved IP at dial time so DNS rebinding cannot reach internal addresses.
Package netguard checks the resolved IP at dial time so DNS rebinding cannot reach internal addresses.
Package proxy abstracts Goma Gateway; TLS termination, ACME issuance and renewal are owned by Goma.
Package proxy abstracts Goma Gateway; TLS termination, ACME issuance and renewal are owned by Goma.
Package runners keeps runner tunnels only to lease jobs and stream logs; runners use their own Docker/BuildKit.
Package runners keeps runner tunnels only to lease jobs and stream logs; runners use their own Docker/BuildKit.
services
account
Package account runs account-wide actions over a user's owned workspaces; each workspace has exactly one owner.
Package account runs account-wide actions over a user's owned workspaces; each workspace has exactly one owner.
adminrecovery
Package adminrecovery is the audited break-glass path; shell access to the control plane is the trust boundary.
Package adminrecovery is the audited break-glass path; shell access to the control plane is the trust boundary.
analytics
Package analytics holds no per-request rows or PII: histogram latency, HLL uniques, daily-salted visitor hash.
Package analytics holds no per-request rows or PII: histogram latency, HLL uniques, daily-salted visitor hash.
announcement
Package announcement broadcasts platform notices as ordinary per-user notification rows.
Package announcement broadcasts platform notices as ordinary per-user notification rows.
application
Package application manages applications, their config, and deployments.
Package application manages applications, their config, and deployments.
apply
Package apply converges a workspace to miabi.io/v1 manifests; GitOps reuses the same engine.
Package apply converges a workspace to miabi.io/v1 manifests; GitOps reuses the same engine.
audit
Package audit writes append-only audit-log entries for mutating actions.
Package audit writes append-only audit-log entries for mutating actions.
auth
Package auth handles password hashing, revocable JWT sessions and password resets.
Package auth handles password hashing, revocable JWT sessions and password resets.
backup
Package backup runs database backups and restores with the *-bkup tools as one-shot containers.
Package backup runs database backups and restores with the *-bkup tools as one-shot containers.
backupsettings
Package backupsettings manages a workspace's shared S3 backup target; the secret is encrypted at rest.
Package backupsettings manages a workspace's shared S3 backup target; the secret is encrypted at rest.
billing
Package billing serves the Billing API, off unless MIABI_BILLING_API_ENABLED and the billing licence flag are set.
Package billing serves the Billing API, off unless MIABI_BILLING_API_ENABLED and the billing licence flag are set.
branding
Package branding owns the install's identity, kept separate from personal accents so neither leaks into the other.
Package branding owns the install's identity, kept separate from personal accents so neither leaks into the other.
certificate
Package certificate manages imported TLS certificates; ACME is handled by Goma.
Package certificate manages imported TLS certificates; ACME is handled by Goma.
cluster
Package cluster drives Docker Swarm as the optional cluster mode, one swarm per cluster.
Package cluster drives Docker Swarm as the optional cluster mode, one swarm per cluster.
config
Package config owns workspace configuration files, encrypted at rest and projected read-only.
Package config owns workspace configuration files, encrypted at rest and projected read-only.
controlmanager
Package controlmanager restores vanished workloads in place, never moves them, and never repairs lost data unattended.
Package controlmanager restores vanished workloads in place, never moves them, and never repairs lost data unattended.
crypto
Package crypto provides AES-GCM at-rest encryption; without a key values are only base64 (dev only).
Package crypto provides AES-GCM at-rest encryption; without a key values are only base64 (dev only).
customrole
Package customrole manages admin-defined roles and forbids privilege escalation beyond the author's own permissions.
Package customrole manages admin-defined roles and forbids privilege escalation beyond the author's own permissions.
database
Package database provisions shared database server instances and manages the logical databases they host.
Package database provisions shared database server instances and manages the logical databases they host.
dbupgrade
Package dbupgrade adapts the app and backup services to the database upgrade interfaces without an import cycle.
Package dbupgrade adapts the app and backup services to the database upgrade interfaces without an import cycle.
directory
Package directory turns a successful LDAP/AD bind into a JIT-provisioned Miabi user with group-mapped access.
Package directory turns a successful LDAP/AD bind into a JIT-provisioned Miabi user with group-mapped access.
dnsprovider
Package dnsprovider manages workspace DNS provider connections; credentials are encrypted and never returned.
Package dnsprovider manages workspace DNS provider connections; credentials are encrypted and never returned.
dockerimport
Package dockerimport adopts unmanaged Docker resources in place, without tearing down what is running.
Package dockerimport adopts unmanaged Docker resources in place, without tearing down what is running.
domain
Package domain manages workspace-owned domains: registration, DNS-verified ownership, and default TLS policy.
Package domain manages workspace-owned domains: registration, DNS-verified ownership, and default TLS policy.
edgegateway
Package edgegateway provisions the Goma gateway on an edge node, which terminates TLS and serves its own routes.
Package edgegateway provisions the Goma gateway on an edge node, which terminates TLS and serves its own routes.
elevation
Package elevation is the admin console unlock (sudo mode): a 2FA-proved token bound to the session jti.
Package elevation is the admin console unlock (sudo mode): a 2FA-proved token bound to the session jti.
eventbus
Package eventbus is an in-process pub/sub for SSE fan-out; single-node only, a separate worker would need Redis.
Package eventbus is an in-process pub/sub for SSE fan-out; single-node only, a separate worker would need Redis.
events
Package events records and streams resource timeline events; one recorder serves every subject type.
Package events records and streams resource timeline events; one recorder serves every subject type.
gitops
Package gitops reconciles Git repos of miabi.io/v1 manifests into a workspace by reusing the apply engine.
Package gitops reconciles Git repos of miabi.io/v1 manifests into a workspace by reusing the apply engine.
gitrepo
Package gitrepo manages encrypted Git credentials and builds the go-git auth shared by probes and deploys.
Package gitrepo manages encrypted Git credentials and builds the go-git auth shared by probes and deploys.
gpu
Package gpu inventories node GPUs over the Docker API, so the node agent needs no changes.
Package gpu inventories node GPUs over the Docker API, so the node agent needs no changes.
groupsync
Package groupsync applies SSO group claims at sign-in, touching only governed memberships and never orphaning a workspace.
Package groupsync applies SSO group claims at sign-in, touching only governed memberships and never orphaning a workspace.
housekeeping
Package housekeeping reconciles a node's Docker state against Miabi's intent: disk report, safe prune, drift.
Package housekeeping reconciles a node's Docker state against Miabi's intent: disk report, safe prune, drift.
image
Package image manages the built-image catalog; its GC never collects a digest a live or pinned release uses.
Package image manages the built-image catalog; its GC never collects a digest a live or pinned release uses.
job
Package job is the request side of Jobs and CronJobs: it creates rows and enqueues them for the worker.
Package job is the request side of Jobs and CronJobs: it creates rows and enqueues them for the worker.
keyring
Package keyring manages per-workspace DEKs wrapped by the master KEK, which never leaves the crypto package.
Package keyring manages per-workspace DEKs wrapped by the master KEK, which never leaves the crypto package.
locationmigration
Package locationmigration moves an app with its data to another location live, keeping the source until finalized.
Package locationmigration moves an app with its data to another location live, keeping the source until finalized.
logintoken
Package logintoken mints short-lived, never-admin personal API keys for "Copy login command", with a single-use SSO hand-off.
Package logintoken mints short-lived, never-admin personal API keys for "Copy login command", with a single-use SSO hand-off.
mailer
Package mailer sends platform emails best-effort and async; unconfigured SMTP or a nil Service is a silent no-op.
Package mailer sends platform emails best-effort and async; unconfigured SMTP or a nil Service is a silent no-op.
managedcert
Package managedcert issues and renews certificates via ACME DNS-01; Goma still serves them as custom certs.
Package managedcert issues and renews certificates via ACME DNS-01; Goma still serves them as custom certs.
marketplace
Package marketplace serves the template catalog and installs templates via the app, database, storage and stack services.
Package marketplace serves the template catalog and installs templates via the app, database, storage and stack services.
marketplace/manifest
Package manifest defines the miabi.io/v1 Template format and its parsing, validation and interpolation.
Package manifest defines the miabi.io/v1 Template format and its parsing, validation and interpolation.
marketplace/remote
Package remote syncs the marketplace registry ETag-conditionally into a Redis cache.
Package remote syncs the marketplace registry ETag-conditionally into a Redis cache.
metadataguard
Package metadataguard keeps containers off the cloud metadata service on every node via a per-node nftables helper.
Package metadataguard keeps containers off the cloud metadata service on every node via a per-node nftables helper.
middleware
Package middleware manages workspace-owned Goma Gateway middlewares and reconciles them into the proxy provider.
Package middleware manages workspace-owned Goma Gateway middlewares and reconciles them into the proxy provider.
monitoring
Package monitoring exposes container metrics and workspace health overviews.
Package monitoring exposes container metrics and workspace health overviews.
netalloc
Package netalloc allocates non-overlapping subnets from one platform pool, ledgered in the DB to survive restarts.
Package netalloc allocates non-overlapping subnets from one platform pool, ledgered in the DB to survive restarts.
network
Package network manages workspace-owned Docker networks, created and removed alongside their DB records.
Package network manages workspace-owned Docker networks, created and removed alongside their DB records.
node
Package node manages Docker host (server) records and their reachability.
Package node manages Docker host (server) records and their reachability.
nodestats
Package nodestats reads host CPU/memory per node: local procfs, agent pushes, or a short-lived sampling container.
Package nodestats reads host CPU/memory per node: local procfs, agent pushes, or a short-lived sampling container.
notify
Package notify fans persisted application events out to a workspace's webhooks and channels.
Package notify fans persisted application events out to a workspace's webhooks and channels.
oauth
Package oauth implements the OAuth 2.0 / OIDC authorization-code login flow against admin-configured providers.
Package oauth implements the OAuth 2.0 / OIDC authorization-code login flow against admin-configured providers.
organization
Package organization manages tenant realms; every nullable organization_id resolves to the default one.
Package organization manages tenant realms; every nullable organization_id resolves to the default one.
passkey
Package passkey runs WebAuthn ceremonies; state in Redis is single-use so a challenge can't be answered twice.
Package passkey runs WebAuthn ceremonies; state in Redis is single-use so a challenge can't be answered twice.
pipeline
Package pipeline implements Miabi's CI/CD: pipeline-as-code, run lifecycle, and the internal container runner.
Package pipeline implements Miabi's CI/CD: pipeline-as-code, run lifecycle, and the internal container runner.
placement
Package placement picks a location then a node for a new resource, once at create; nothing is rescheduled.
Package placement picks a location then a node for a new resource, once at create; nothing is rescheduled.
platformbackup
Package platformbackup is admin-only control-plane disaster recovery; artifacts use the backup passphrase, not the master key.
Package platformbackup is admin-only control-plane disaster recovery; artifacts use the backup passphrase, not the master key.
platformimage
Package platformimage is the single source of truth for platform images: code defaults, admin overrides, optional mirror.
Package platformimage is the single source of truth for platform images: code defaults, admin overrides, optional mirror.
platformrestore
Package platformrestore rebuilds a platform onto a fresh host from a recovery point, outside the control plane.
Package platformrestore rebuilds a platform onto a fresh host from a recovery point, outside the control plane.
portbinding
Package portbinding queues host-port requests for admin approval, since host ports are a node-wide shared resource.
Package portbinding queues host-port requests for admin approval, since host ports are a node-wide shared resource.
portforward
Package portforward exposes a managed database on demand via an ephemeral listener bridged to an in-network socat relay.
Package portforward exposes a managed database on demand via an ephemeral listener bridged to an in-network socat relay.
quota
Package quota enforces plan limits; effective limits resolve override, plan, default plan, then unlimited.
Package quota enforces plan limits; effective limits resolve override, plan, default plan, then unlimited.
recovery
Package recovery converges a restored control-plane DB, whose rows describe a machine that no longer exists, onto this host.
Package recovery converges a restored control-plane DB, whose rows describe a machine that no longer exists, onto this host.
registration
Package registration owns self-service sign-up, off by default so upgraded installs never silently accept accounts.
Package registration owns self-service sign-up, off by default so upgraded installs never silently accept accounts.
registry
Package registry manages container-registry credentials for pulling private images; secrets are encrypted at rest.
Package registry manages container-registry credentials for pulling private images; secrets are encrypted at rest.
registryserver
Package registryserver runs the built-in multi-tenant registry; tenant requests are authorized via Goma forwardAuth.
Package registryserver runs the built-in multi-tenant registry; tenant requests are authorized via Goma forwardAuth.
release
Package release turns per-app releases into promotable artifacts with provenance and per-environment approval gates.
Package release turns per-app releases into promotable artifacts with provenance and per-environment approval gates.
restriction
Package restriction holds admin workspace restrictions and the gate every workload-changing entry point consults.
Package restriction holds admin workspace restrictions and the gate every workload-changing entry point consults.
route
Package route manages Goma Gateway routes bound to applications and reconciles them into the proxy provider.
Package route manages Goma Gateway routes bound to applications and reconciles them into the proxy provider.
runner
Package runner manages build runners: dedicated machines that never host apps, dialing in over a tunnel.
Package runner manages build runners: dedicated machines that never host apps, dialing in over a tunnel.
sealing
Package sealing manages workspace sealing keys; private keys stay wrapped under the master KEK.
Package sealing manages workspace sealing keys; private keys stay wrapped under the master KEK.
secpolicy
Package secpolicy enforces scoped platform security rules; specific scopes may only tighten the platform rule.
Package secpolicy enforces scoped platform security rules; specific scopes may only tighten the platform rule.
secret
Package secret is the Vault: encrypted workspace secrets referenced from env and resolved at deploy or job time.
Package secret is the Vault: encrypted workspace secrets referenced from env and resolved at deploy or job time.
serviceaccount
Package serviceaccount manages workspace-owned non-human users that sign in only with API keys.
Package serviceaccount manages workspace-owned non-human users that sign in only with API keys.
session
Package session maintains a Redis-backed JWT revocation list keyed by jti.
Package session maintains a Redis-backed JWT revocation list keyed by jti.
settings
Package settings provides cached, typed access to platform-wide key/value settings stored in the database.
Package settings provides cached, typed access to platform-wide key/value settings stored in the database.
stack
Package stack groups apps organizationally; deleting a stack detaches its apps, which keep running.
Package stack groups apps organizationally; deleting a stack detaches its apps, which keep running.
storage
Package storage manages persistent (Docker) volumes owned by workspaces.
Package storage manages persistent (Docker) volumes owned by workspaces.
storageclass
Package storageclass manages admin-registered volume directories, so tenants name a class, never a host path.
Package storageclass manages admin-registered volume directories, so tenants name a class, never a host path.
telemetry
Package telemetry sends one anonymous startup and daily event; failures never affect the platform.
Package telemetry sends one anonymous startup and daily event; failures never affect the platform.
transfer
Package transfer splices bytes between Docker engines through the control plane; nodes never talk directly.
Package transfer splices bytes between Docker engines through the control plane; nodes never talk directly.
twofactor
Package twofactor wraps TOTP (RFC 6238); the caller owns persistence and encryption of the secret.
Package twofactor wraps TOTP (RFC 6238); the caller owns persistence and encryption of the secret.
updatecheck
Package updatecheck checks versions.miabi.io daily and notifies; it never upgrades anything itself.
Package updatecheck checks versions.miabi.io daily and notifies; it never upgrades anything itself.
usersettings
Package usersettings owns per-user preferences, separate from account lifecycle.
Package usersettings owns per-user preferences, separate from account lifecycle.
versioning
Package versioning reserves each pipeline run's version (image tag); deploys stay by digest.
Package versioning reserves each pipeline run's version (image tag); deploys stay by digest.
volumebackup
Package volumebackup archives managed volumes to the workspace's S3 target via volume-bkup; S3 is required.
Package volumebackup archives managed volumes to the workspace's S3 target via volume-bkup; S3 is required.
webhook
Package webhook manages workspace webhooks and signed delivery; signing secrets are encrypted at rest.
Package webhook manages workspace webhooks and signed delivery; signing secrets are encrypted at rest.
workspace
Package workspace manages workspaces, memberships, and invitations.
Package workspace manages workspaces, memberships, and invitations.
workspacekeys
Package workspacekeys rotates a workspace's data and sealing keys together, at most once per RotationInterval.
Package workspacekeys rotates a workspace's data and sealing keys together, at most once per RotationInterval.
wsbackup
Package wsbackup exports a workspace to a portable S3 bundle another install can read, and restores it.
Package wsbackup exports a workspace to a portable S3 bundle another install can read, and restores it.
Package siem streams the audit log at-least-once; the cursor advances only on a successful ship.
Package siem streams the audit log at-least-once; the cursor advances only on a successful ship.
Package slug derives URL/DNS-safe identifiers from human names.
Package slug derives URL/DNS-safe identifiers from human names.
blob
Package blob is a minimal S3 client for bundle control objects and `miabi restore` on a bare host.
Package blob is a minimal S3 client for bundle control objects and `miabi restore` on a bare host.
logbackfill
Package logbackfill moves old large log rows to the log store at boot, since it must wait for the store.
Package logbackfill moves old large log rows to the log store at boot, since it must wait for the store.
migration/upgrade
Package upgrade runs once-only data backfills; schema DDL belongs in the migration package.
Package upgrade runs once-only data backfills; schema DDL belongs in the migration package.
Package web embeds the built Vue SPA; only a .gitkeep in dist/ is committed so go build works without the UI.
Package web embeds the built Vue SPA; only a .gitkeep in dist/ is committed so go build works without the UI.
Package webhooksig verifies inbound provider push webhooks.
Package webhooksig verifies inbound provider push webhooks.
Package worker holds the asynq producer, task types, and handlers for background work.
Package worker holds the asynq producer, task types, and handlers for background work.
Package wsbundle defines the Miabi Portable Bundle format; it depends on nothing else in Miabi.
Package wsbundle defines the Miabi Portable Bundle format; it depends on nothing else in Miabi.

Jump to

Keyboard shortcuts

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