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 | The ASP.NET Core / Blazor host process that loads Packages, exposes HTTP endpoints, and serves the admin UI. |
| Package | A deployable unit described by a trakhound.package.json manifest. Each Package has a category: api, app, function, worker, service, or identity. |
| Api | 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 | A Blazor user interface hosted within the Instance. |
| Function | 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 | A long-running background process. |
| Service | A backing provider for data primitives: Blobs, Key-Values, Messages, Message Queues, Tables, and Time Series. |
| Router | 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 | An authentication provider (token, OpenID Connect, LDAP, or the built-in API keys and users) used to secure APIs, Apps, and Service operations. |
| Volume | A scoped storage area provided to Packages for files and configuration. |
| Zone | A group of modules whose calls through the Instance are limited to what the Zone's Rules allow. |
| Configuration Variable | 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
- You create a Package from a .NET template, write your code, and pack it with the CLI.
- The Package is published to a package server and installed on one or more Instances.
- In the Instance's admin UI you create a configuration for the Package, choosing its route, Volume, and Router, along with any parameters.
- The Instance loads the Package. When a new version is installed, it is loaded without restarting the Instance.
- Packages read and write data through Services, and Routers decide which Service handles each request.
- Security profiles control who can use each API, App, and Service, and Zones control what each module can reach.
- People use the Apps and APIs, developers find APIs in the API Catalog, and AI assistants connect through the MCP Server.
How a Request Flows
Each request passes through the same steps, and each step can refuse it with its own status code:
401 No valid key or session for a protected resource403 The caller's roles don't allow itClient.Services, Functions, or other APIs403 Zone Access Denied, only for modules in a Zone405 No Service for this kind of data on the Router503 / 504 The backend is unavailable or timed out