These Packages are included with the TrakHound Framework and can be installed on any Instance.
TrakHound.. Scheduling needs both Functions.Api and the ScheduledTasks Packages.Packages and Functions
| Package | Category | Description |
|---|---|---|
TrakHound.Packages.Api | api | Download, upload, and manage Packages |
TrakHound.Packages.App | app | User interface for managing Packages |
TrakHound.ApiExplorer.App | app | Browse the APIs you can use, try them out, and download their OpenAPI documents (see API Catalog & Explorer) |
TrakHound.Welcome.App | app | A home page (at /) for development Instances: what's installed, where it's served, and how to get started (see Debugging & Testing). Installs the API Explorer with it. Don't install it in production |
TrakHound.Packages.Retention.Function | function | Delete older Package versions |
TrakHound.Functions.Api | api | View, run, and manage Functions, Jobs, and Scheduled Tasks |
TrakHound.Functions.Retention.Function | function | Clean up older Function run history |
TrakHound.ScheduledTasks.Api | api | Manage Scheduled Tasks that run Functions on a CRON schedule |
TrakHound.ScheduledTasks.Worker | worker | Runs Functions (with their Job's Parameters) on a CRON schedule and reports each Task's status |
Examples
Example Packages that work together around a simulated sensor, so a new Instance has something running to look at and copy from. Install TrakHound.Example.App from Packages to install and configure all four,
or run th packages install TrakHound.Example.App --configure, then open /example. Their source is in the Framework repository's examples folder.
| Package | Category | What it shows |
|---|---|---|
TrakHound.Example.Worker | worker | A background loop that reads a simulated sensor and writes the recent readings to a shared Volume |
TrakHound.Example.Function | function | A Function with a described input parameter that summarizes the readings |
TrakHound.Example.Api | api | Described endpoints marked as MCP Tools, a stream, running a Function, and Variables (route example/api) |
TrakHound.Example.App | app | A Blazor page that calls the API through the Client and refreshes on a timer (route example) |
Services
| Package | Provides | License |
|---|---|---|
TrakHound.FileSystem.Service | Blobs stored on the file system | Free |
TrakHound.Memory.Service | In-memory Key-Values (with a configurable TTL), Messages, and Message Queues, for development and tests without a broker | Free |
TrakHound.Http.Service | Route Services to another TrakHound Instance over HTTP | Free |
TrakHound.Mqtt.Service | Messages using MQTT | Free |
TrakHound.RabbitMq.Service | Message Queues using RabbitMQ | Free |
TrakHound.Redis.Service | Key-Values using Redis | Free |
TrakHound.SqlServer.Service | Tables using SQL Server | Free |
See Services for how to use them.
Identity
| Package | Description |
|---|---|
TrakHound.Oidc.Identity | Sign in with an OpenID Connect server (ex. Microsoft Entra ID, Okta, Keycloak) and accept its Bearer tokens |
TrakHound.Ldap.Identity | Sign in with a username and password verified by an LDAP server (ex. Active Directory) |
TrakHound.Token.Identity | Authentication using a configurable static token |
API keys and Users are built into the Instance and don't need a Package. See Identity.
Libraries
Packages are built on these libraries, which are referenced by the project templates:
| Library | Description |
|---|---|
TrakHound.Common | Core abstractions: APIs, Apps, Clients, Functions, Workers, Services, Packages, Volumes, Variables, Security, and Logging |
TrakHound.Blazor | Shared Blazor components, layouts, and routing |
TrakHound.Blazor.Hosting | Static assets (CSS, fonts, and JavaScript) for hosting TrakHound Blazor apps |
TrakHound.Blazor.Diagrams | Blazor diagramming components (used for the Routing editor and the Zone Map) |
TrakHound.Debug, TrakHound.Debug.AspNetCore, TrakHound.Debug.Apps | Local debug hosts that read trakhound.debug.json and run modules without an Instance, including the Api Debugger. Used by the templates and left out when a Package is built (see Debugging & Testing) |
TrakHound.Testing | Unit tests without an Instance: TrakHoundTestContext and an in-memory test client. Reference it from a test project, not the Package project |
TrakHound.Hosting, TrakHound.Hosting.AspNetCore | Run an Api, Worker, or Function outside an Instance, with the standard .NET host (see Standalone Hosts) |
The Instance provides TrakHound.Common and TrakHound.Blazor at runtime, so they aren't copied into Packages.