Overview

A modular .NET 10 platform for building, deploying, and hosting applications as installable Packages.
Framework Docs Menu

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

TermDescription
InstanceThe ASP.NET Core / Blazor host process that loads Packages, exposes HTTP endpoints, and serves the admin UI.
PackageA deployable unit described by a trakhound.package.json manifest. Each Package has a category: api, app, function, worker, service, or identity.
ApiA 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.
AppA Blazor user interface hosted within the Instance.
FunctionA 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.
WorkerA long-running background process.
ServiceA backing provider for data primitives: Blobs, Key-Values, Messages, Message Queues, Tables, and Time Series.
RouterSends 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.
IdentityAn authentication provider (token, OpenID Connect, LDAP, or the built-in API keys and users) used to secure APIs, Apps, and Service operations.
VolumeA scoped storage area provided to Packages for files and configuration.
ZoneA group of modules whose calls through the Instance are limited to what the Zone's Rules allow.
Configuration VariableA 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, write your code, and pack it with the 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, and Routers decide which Service handles each request.
  6. Security profiles control who can use each API, App, and Service, and Zones control what each module can reach.
  7. 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:

Client A browser, script, application, AI assistant, or another Instance
HTTP request, with an API key or sign-in cookie
Instance
IdentityWho is calling? API keys, users, OpenID Connect, LDAP, or a token
401 No valid key or session for a protected resource
Security ProfilesMay this caller use this API endpoint or App page?
403 The caller's roles don't allow it
Your API or AppRuns your code, which calls Client.Services, Functions, or other APIs
Workers and Functions start here, with no caller
ZoneMay this module reach that Service, API, Function, or Volume?
403 Zone Access Denied, only for modules in a Zone
RouterWhich Service handles this kind of data? Tries the Route's Targets in order
405 No Service for this kind of data on the Router
ServiceReads or writes using the connection details set by IT
503 / 504 The backend is unavailable or timed out
Databases, Brokers, and Files SQL Server, Redis, MQTT, RabbitMQ, the file system, or another Instance
Profiles decide who can come in; Zones decide what each module can reach out to; Routers decide where data goes.

Explore the Docs

TrakHound Framework is open source under the Apache License, Version 2.0, which includes a patent grant. The source code is on GitHub, where bug reports, fixes, and new features are welcome (see its contributing guidelines). Report security problems privately, as its security policy describes, not in a public issue.