# Overview

> A modular .NET 10 platform for building, deploying, and hosting applications as installable Packages.

URL: https://www.trakhound.com/docs/trakhound-framework

TrakHound Framework is a modular .NET 10 platform for building, deploying, and hosting **APIs, Blazor Apps, Functions, Workers, Services, and Identity providers** as installable Packages. A TrakHound **Instance** hosts these Packages, routes requests to them, and provides a browser-based admin UI for configuration, exploration, and deployment.

Each part of a project is built as its own Package with a single responsibility, so it can be developed, versioned, and deployed independently, and shared between projects and Instances.

## Concepts

| Term | Description |
| --- | --- |
| **[Instance](https://www.trakhound.com/docs/trakhound-framework/instances)** | The ASP.NET Core / Blazor host process that loads Packages, exposes HTTP endpoints, and serves the admin UI. |
| **[Package](https://www.trakhound.com/docs/trakhound-framework/packages)** | A deployable unit described by a `trakhound.package.json` manifest. Each Package has a category: `api`, `app`, `function`, `worker`, `service`, or `identity`. |
| **[Api](https://www.trakhound.com/docs/trakhound-framework/apis)** | A controller-style HTTP API mounted at a configurable route. Supports GET, PUT, POST, and DELETE requests and streaming responses (WebSocket or Server-Sent Events). Endpoints can also be served as MCP Tools. |
| **[App](https://www.trakhound.com/docs/trakhound-framework/apps)** | A Blazor user interface hosted within the Instance. |
| **[Function](https://www.trakhound.com/docs/trakhound-framework/functions)** | A unit of code that is run on demand or on a schedule. A **Job** is a named set of Parameters for a Function, and a **Scheduled Task** runs a Function (optionally with a Job) on a CRON schedule. |
| **[Worker](https://www.trakhound.com/docs/trakhound-framework/workers)** | A long-running background process. |
| **[Service](https://www.trakhound.com/docs/trakhound-framework/services)** | A backing provider for data primitives: Blobs, Key-Values, Messages, Message Queues, Tables, and Time Series. |
| **[Router](https://www.trakhound.com/docs/trakhound-framework/routing)** | Sends Service calls to Services (or other Routers). Each Route tries its Targets in order, falling back to the next one when a Target doesn't have the data or can't answer. |
| **[Identity](https://www.trakhound.com/docs/trakhound-framework/identity)** | An authentication provider (token, OpenID Connect, LDAP, or the built-in API keys and users) used to secure APIs, Apps, and Service operations. |
| **[Volume](https://www.trakhound.com/docs/trakhound-framework/volumes-and-variables)** | A scoped storage area provided to Packages for files and configuration. |
| **[Zone](https://www.trakhound.com/docs/trakhound-framework/zones)** | A group of modules whose calls through the Instance are limited to what the Zone's Rules allow. |
| **[Configuration Variable](https://www.trakhound.com/docs/trakhound-framework/configuration#variables)** | A value shared by every configuration in a profile, referenced from parameter values as `${name}` (or `${env:NAME}` for an environment variable). |

## How It Fits Together

1. You create a Package from a [.NET template](https://www.trakhound.com/docs/trakhound-framework/getting-started), write your code, and pack it with the [CLI](https://www.trakhound.com/docs/trakhound-framework/cli).
2. The Package is published to a package server and installed on one or more Instances.
3. In the Instance's admin UI you create a configuration for the Package, choosing its route, Volume, and Router, along with any parameters.
4. The Instance loads the Package. When a new version is installed, it is loaded without restarting the Instance.
5. Packages read and write data through [Services](https://www.trakhound.com/docs/trakhound-framework/services), and [Routers](https://www.trakhound.com/docs/trakhound-framework/routing) decide which Service handles each request.
6. [Security profiles](https://www.trakhound.com/docs/trakhound-framework/security) control who can use each API, App, and Service, and [Zones](https://www.trakhound.com/docs/trakhound-framework/zones) control what each module can reach.
7. People use the Apps and APIs, developers find APIs in the [API Catalog](https://www.trakhound.com/docs/trakhound-framework/api-catalog), and AI assistants connect through the [MCP Server](https://www.trakhound.com/docs/trakhound-framework/mcp-server).

## How a Request Flows

Each request passes through the same steps, and each step can refuse it with its own status code:

Diagram: A request from a client is identified, checked against security profiles, handled by your API, which calls a Service through its Client. The call is checked against the module's Zone, sent by a Router to a Service, and reaches a database or broker. Each step can refuse the request with its own status code.

## Explore the Docs

[Quick Start Create an API, install it on an Instance, and update it while it runs, in about 10 minutes.](https://www.trakhound.com/docs/trakhound-framework/getting-started) [Build an API Controllers, route attributes, responses, and streaming.](https://www.trakhound.com/docs/trakhound-framework/apis) [Work with Data Blobs, Key-Values, Messages, Message Queues, Tables, and Time Series.](https://www.trakhound.com/docs/trakhound-framework/services) [Connect AI Assistants Run Functions, read data, and call APIs from Claude and other MCP clients.](https://www.trakhound.com/docs/trakhound-framework/mcp-server) [Secure Modules Limit what modules in development or written with AI tools can reach.](https://www.trakhound.com/docs/trakhound-framework/zones) [CLI Reference Pack, publish, and install Packages and Deployments.](https://www.trakhound.com/docs/trakhound-framework/cli)

> TrakHound Framework is open source under the Apache License, Version 2.0, which includes a patent grant. The source code is on [GitHub](https://github.com/TrakHound/TrakHound.Framework), where bug reports, fixes, and new features are welcome (see its [contributing guidelines](https://github.com/TrakHound/TrakHound.Framework/blob/main/CONTRIBUTING.md)). Report security problems privately, as its [security policy](https://github.com/TrakHound/TrakHound.Framework/blob/main/SECURITY.md) describes, not in a public issue.
