How-to guides

How-to guides are recipes. Each one solves a single real task and assumes you already know the basics (if you don't, start with the tutorial). For the full option set behind any task, follow the links into the reference.

Configuration

• Configure your application with YAML — profiles, environment variables, database keys, server deployment.
• Add typed service configuration — load and inject your own config objects with ConfigBinder, @ConfigPrefix, and ConfigBinding.

Persistence

• Define tables and repositories — map entities, add custom queries, run managed raw SQL.
• Run database migrations — write migrations, control startup execution, check status and dry-runs.

Application features

• Schedule background jobs — cron, fixed-delay, fixed-rate, and one-time jobs.
• Publish and handle events — domain events, handlers, and transaction-aware publishing.
• Add routes, middleware, and exception handlers — the Ktor DSLs Katalyst installs for you.
• Add WebSockets — real-time endpoints with auto-discovery.

Runtime

• Choose a server engine — Netty, Jetty, or CIO.
• Test your application — unit, integration, and end-to-end tests.

Tooling

• Install the IDE plugin — teach IntelliJ IDEA and Android Studio Katalyst's conventions so entrypoints aren't flagged unused (no @Suppress needed).