> For the complete documentation index, see [llms.txt](https://docs.elsaworkflows.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.elsaworkflows.io/guides.md). # Guides - [V2 to V3 Migration Guide](https://docs.elsaworkflows.io/guides/migration-v2-to-v3.md): Complete migration guide from Elsa Workflows V2 to V3, covering breaking changes, custom activities, workflows, and concepts. - [Architecture](https://docs.elsaworkflows.io/guides/architecture.md): High-level overview of Elsa Workflows v3 architecture, covering workflow execution flow, core concepts like bookmarks and triggers, workflow runtimes, and multitenancy. - [Workflow Dispatcher Architecture](https://docs.elsaworkflows.io/guides/architecture/workflow-dispatcher.md): Deep dive into IWorkflowDispatcher: the core dispatching abstraction for queuing and executing workflows, covering request types, event ordering, and custom dispatcher implementations. - [Onboarding](https://docs.elsaworkflows.io/guides/onboarding.md) - [Hosting Elsa in an Existing App](https://docs.elsaworkflows.io/guides/onboarding/hosting-elsa-in-existing-app.md): Step-by-step guide to integrating Elsa Workflows into an existing ASP.NET Core application, including persistence setup, common pain points, and troubleshooting. - [Authentication & Authorization](https://docs.elsaworkflows.io/guides/authentication.md): Comprehensive guide to configuring authentication and authorization for Elsa Workflows, covering OIDC providers, API keys, custom authentication, and security best practices. - [Security & Authentication](https://docs.elsaworkflows.io/guides/security.md): Comprehensive guide to securing Elsa Server and workflows end-to-end, covering identity, authentication, tokenized resume URLs, CORS, secrets management, and production hardening. - [Disable Auth in Development](https://docs.elsaworkflows.io/guides/security/disable-auth.md): Guide for disabling authentication in Elsa Server and Studio during development to simplify local testing and experimentation. - [External Identity Providers](https://docs.elsaworkflows.io/guides/security/external-identity-providers.md): Guide to integrating Elsa Server with external identity providers including Microsoft Entra ID, Auth0, Keycloak, and other OpenID Connect / OAuth2 providers. - [Deployment](https://docs.elsaworkflows.io/guides/deployment.md) - [Kubernetes Basics](https://docs.elsaworkflows.io/guides/deployment/kubernetes.md): Quick start guide for deploying Elsa Workflows to Kubernetes with PostgreSQL persistence, including configuration, troubleshooting, and production best practices. - [Kubernetes Deployment](https://docs.elsaworkflows.io/guides/kubernetes-deployment.md): Complete Kubernetes deployment guide for Elsa Workflows including Helm charts, deployment configurations, ingress setup, autoscaling, monitoring, service mesh integration, and production best practice - [Integration](https://docs.elsaworkflows.io/guides/integration.md) - [Blazor Dashboard](https://docs.elsaworkflows.io/guides/integration/blazor-dashboard.md): Guide to integrating Elsa Studio with Blazor Server applications, covering hosting patterns, authentication configuration, and troubleshooting common issues. - [Clustering](https://docs.elsaworkflows.io/guides/clustering.md): Comprehensive guide to running Elsa Workflows in clustered and distributed production environments, covering architecture patterns, distributed locking, scheduling, and operational best practices. - [Performance & Scaling](https://docs.elsaworkflows.io/guides/performance.md): Comprehensive guide to optimizing Elsa Workflows for high-throughput scenarios, covering commit strategies, state persistence tuning, observability, and performance best practices. - [Throughput Tuning](https://docs.elsaworkflows.io/guides/performance/throughput-tuning.md): Practical examples for tuning Elsa Workflows throughput, including commit strategies, clustering optimizations, and resource management. - [API & Client](https://docs.elsaworkflows.io/guides/api-client.md): Comprehensive guide to interacting with Elsa Server programmatically via HTTP APIs and the elsa-api-client library, covering workflow publishing, instance management, bookmarks, and resilience pattern - [Persistence](https://docs.elsaworkflows.io/guides/persistence.md): Comprehensive guide to choosing, configuring, and tuning persistence providers for Elsa Workflows v3, covering EF Core, MongoDB, and Dapper, along with retention, migrations, and operational best prac - [SQL Server](https://docs.elsaworkflows.io/guides/persistence/sql-server.md): Complete guide to configuring SQL Server as the persistence provider for Elsa Workflows v3, including setup, configuration, and migration guidance. - [EF Core Migrations](https://docs.elsaworkflows.io/guides/persistence/ef-migrations.md): Complete guide to working with Entity Framework Core migrations in Elsa Workflows v3, including custom migrations, DbContext management, and versioning strategies. - [EF Core Setup](https://docs.elsaworkflows.io/guides/persistence/efcore-setup.md): Minimal example to enable Entity Framework Core persistence for Elsa Workflows, including database provider setup and migrations. - [MongoDB Setup](https://docs.elsaworkflows.io/guides/persistence/mongodb-setup.md): Minimal example to enable MongoDB persistence for Elsa Workflows, including connection configuration and indexing notes. - [Dapper Setup](https://docs.elsaworkflows.io/guides/persistence/dapper-setup.md): Minimal example to enable Dapper persistence for Elsa Workflows, including connection provider setup and migrations. - [Indexing Notes](https://docs.elsaworkflows.io/guides/persistence/indexing-notes.md): Recommended database indexes for Elsa Workflows persistence stores to optimize common query patterns. - [HTTP Workflows](https://docs.elsaworkflows.io/guides/http-workflows.md) - [Tutorial](https://docs.elsaworkflows.io/guides/http-workflows/tutorial.md) - [Programmatic](https://docs.elsaworkflows.io/guides/http-workflows/programmatic.md) - [Designer](https://docs.elsaworkflows.io/guides/http-workflows/designer.md) - [External Application Interaction](https://docs.elsaworkflows.io/guides/external-application-interaction.md) - [Loading Workflows from JSON](https://docs.elsaworkflows.io/guides/loading-workflows-from-json.md) - [Plugins & Modules](https://docs.elsaworkflows.io/guides/plugins-modules.md): Complete guide to extending Elsa Workflows with custom modules, features, and activities. Learn how to create reusable plugins and distribute them as NuGet packages. - [Extensibility](https://docs.elsaworkflows.io/guides/modules-and-plugins.md): Learn how to extend Elsa Workflows v3 with custom modules and plugins. Covers module registration, contributing activities, services, and API endpoints with practical examples. - [Testing & Debugging Workflows](https://docs.elsaworkflows.io/guides/testing-debugging.md): Comprehensive guide to testing and debugging workflows in Elsa Workflows, covering unit testing, integration testing, debugging techniques, test data management, CI/CD integration, and best practices. - [Running Workflows](https://docs.elsaworkflows.io/guides/running-workflows.md) - [Using Elsa Studio](https://docs.elsaworkflows.io/guides/running-workflows/using-elsa-studio.md) - [Using a Trigger](https://docs.elsaworkflows.io/guides/running-workflows/using-a-trigger.md) - [Dispatch Workflow Activity](https://docs.elsaworkflows.io/guides/running-workflows/dispatch-workflow-activity.md) - [Studio User Guide](https://docs.elsaworkflows.io/guides/studio.md): A comprehensive guide to using Elsa Studio, the visual designer and admin UI for Elsa Workflows v3. - [Expressions](https://docs.elsaworkflows.io/guides/studio/expressions.md): Learn how Elsa Studio expression editors map to Elsa Server expression engines, how to access workflow variables, and which syntax choices are actually available in Elsa 3.8. - [Customization](https://docs.elsaworkflows.io/guides/studio/customization.md): Source-backed guide to the main Elsa Studio customization seams in release 3.8.0, including host composition, branding, menus, widgets, activity pickers, and editor extensibility. - [Custom UI Components](https://docs.elsaworkflows.io/guides/studio/custom-ui-components.md): Source-backed guide to customizing Elsa Studio input editors in release 3.8.0 using backend UI hints, property UI handlers, and Studio UI hint handlers. - [Integration](https://docs.elsaworkflows.io/guides/studio/integration.md): Source-backed guide to the Elsa Studio host models available in release 3.8.0, including standalone hosts, custom elements, backend configuration, and authentication. - [Custom Elements Embedding](https://docs.elsaworkflows.io/guides/studio/integration/custom-elements.md): Source-backed cookbook for embedding Elsa Studio custom elements in release 3.8.0, including backend configuration, authentication, tenant headers, and React usage. - [Workflow Patterns](https://docs.elsaworkflows.io/guides/patterns.md): A practical, pattern-based guide to designing and implementing common workflow patterns with Elsa Workflows v3. Each pattern provides grounded guidance, code snippets, pitfalls, and references to elsa - [Troubleshooting](https://docs.elsaworkflows.io/guides/troubleshooting.md): Comprehensive troubleshooting guide for diagnosing and resolving common Elsa Workflows issues in development and production environments. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.elsaworkflows.io/guides.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.