Documentation
How to run, configure, extend and operate the kit.
Getting started
Getting startedFrom a clone to the running kit: the local stack, the demo organization, signing in, becoming a super-admin and the administrative commands of the API binary.
Local developmentHow to work on the Colden kit on one machine: the whole stack in Compose, a host or the web run from source against the stack's services, the commands of the hosts, email, payments, tests and the usual problems.
ConfigurationHow the kit's hosts read configuration: the layers, the environment-variable form, the secrets, adding a key, how values reach Compose and a cluster, and changing a value or a secret.
Adding a featureThe path of a new feature through the Colden kit, from the endpoint to the screen: the vertical slice, its tests, the OpenAPI document and the SDK, the page, and the documentation, with the agent skills that do each step.
RebrandingHow a product rebrands the Colden kit in six moves (accent scale, neutral scale, font, radius, density, logo) through the design tokens, then gives it its own name in the web, the emails and the identity server, and checks the result.
Deploying Colden to a clusterWhat a Kubernetes cluster needs before the first Colden release, how to prepare a namespace, the first deployment and the checks that prove it works.
Platform
TenancyHow the kit keeps organizations apart: the shared database with the tenant column and query filters by default, and the opt-in schema per organization for a product's own tables.
Authentication and account securityWhich Ory Kratos method backs which sign-in and account screen of the kit, the account security API (security overview, sessions, account deletion), and how to turn a method or a surface off.
Authorization in the Colden kitHow the API decides who may call an endpoint: authentication schemes, the current user, the policies and who passes each, the permission matrix, the owner rules, the step-up for super-admins and how a new endpoint declares its policy.
Feature flagsHow the kit switches features on per organization: flags with a default, a rollout share and per-organization overrides, read by code and by the web, managed by super-admins.
Billing in the Colden kitHow the kit bills organizations through Stripe: the mirror and why the application reads only it, the plan catalog, the trial, cancellation and resumption endpoints, the webhook through the billing queue, the events billing publishes, local development with the Stripe CLI and testing.
The audit logWhat the kit records in an organization's audit log and how, how admins read, filter and export it, how long entries are kept, and how a slice names or adds an action.
EmailHow the kit keeps transactional email deliverable: the Mailgun domain's SPF, DKIM and DMARC records, the provider's webhooks, the suppression list, List-Unsubscribe for notifications, Mailpit in development, and adding a template.
Messaging and jobsHow the Colden kit moves work off the request: Wolverine messages on PostgreSQL queues published with the data that causes them, the worker's handlers, the recurring jobs Hangfire schedules, failures and replay, and how to add a message or a job.
CachingHow the kit caches: HybridCache over Redis or memory, the key and tag conventions, what is cached and for how long, adding a cached read to a slice, tests, Redis sizing and eviction, and what happens while Redis is down.
Operations
ObservabilityHow to see what the Colden kit is doing: where traces, metrics and logs go, how to follow one organization's request through the API, the outbox and the worker, and what never appears in telemetry.
Testing the Colden kitHow the kit's .NET tests are written and run: the test stack, the shared test infrastructure in Colden.Testing, integration tests on PostgreSQL and Redis containers, host tests, and how the pipeline runs them.
The Colden pipelineWhat the GitLab pipeline runs in each stage, what the runner and the project need, how a project describes its environments and how a deployment and a rollback happen.