TrakHound Docs TrakHound Framework First-Party Packages

First-Party Packages

Packages included with the TrakHound Framework.
Framework Docs Menu

These Packages are included with the TrakHound Framework and can be installed on any Instance.

Manage Packages
Packages.ApiPackages.AppPackages.Retention.Function
Functions & Scheduling
Functions.ApiScheduledTasks.ApiScheduledTasks.WorkerFunctions.Retention.Function
Services
FileSystemMemoryHttpMqttRabbitMqRedisSqlServerPostgreSqlSqlite
Identity
Oidc.IdentityLdap.IdentityToken.IdentityAPI keys & Users (built in)
Developer Tools
ApiExplorer.AppWelcome.App
All names start with TrakHound.. Scheduling needs both Functions.Api and the ScheduledTasks Packages.

Packages and Functions

PackageCategoryDescription
TrakHound.Packages.ApiapiDownload, upload, and manage Packages
TrakHound.Packages.AppappUser interface for managing Packages
TrakHound.ApiExplorer.AppappBrowse the APIs you can use, try them out, and download their OpenAPI documents (see API Catalog & Explorer)
TrakHound.Welcome.AppappA 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.FunctionfunctionDelete older Package versions
TrakHound.Functions.ApiapiView, run, and manage Functions, Jobs, and Scheduled Tasks
TrakHound.Functions.Retention.FunctionfunctionClean up older Function run history
TrakHound.ScheduledTasks.ApiapiManage Scheduled Tasks that run Functions on a CRON schedule
TrakHound.ScheduledTasks.WorkerworkerRuns 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.

PackageCategoryWhat it shows
TrakHound.Example.WorkerworkerA background loop that reads a simulated sensor and writes the recent readings to a shared Volume
TrakHound.Example.FunctionfunctionA Function with a described input parameter that summarizes the readings
TrakHound.Example.ApiapiDescribed endpoints marked as MCP Tools, a stream, running a Function, and Variables (route example/api)
TrakHound.Example.AppappA Blazor page that calls the API through the Client and refreshes on a timer (route example)

Services

PackageProvidesLicense
TrakHound.FileSystem.ServiceBlobs stored on the file systemFree
TrakHound.Memory.ServiceIn-memory Key-Values (with a configurable TTL), Messages, and Message Queues, for development and tests without a brokerFree
TrakHound.Http.ServiceRoute Services to another TrakHound Instance over HTTPFree
TrakHound.Mqtt.ServiceMessages using MQTTFree
TrakHound.RabbitMq.ServiceMessage Queues using RabbitMQFree
TrakHound.Redis.ServiceKey-Values using RedisFree
TrakHound.SqlServer.ServiceTables using SQL ServerFree

See Services for how to use them.

Identity

PackageDescription
TrakHound.Oidc.IdentitySign in with an OpenID Connect server (ex. Microsoft Entra ID, Okta, Keycloak) and accept its Bearer tokens
TrakHound.Ldap.IdentitySign in with a username and password verified by an LDAP server (ex. Active Directory)
TrakHound.Token.IdentityAuthentication 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:

LibraryDescription
TrakHound.CommonCore abstractions: APIs, Apps, Clients, Functions, Workers, Services, Packages, Volumes, Variables, Security, and Logging
TrakHound.BlazorShared Blazor components, layouts, and routing
TrakHound.Blazor.HostingStatic assets (CSS, fonts, and JavaScript) for hosting TrakHound Blazor apps
TrakHound.Blazor.DiagramsBlazor diagramming components (used for the Routing editor and the Zone Map)
TrakHound.Debug, TrakHound.Debug.AspNetCore, TrakHound.Debug.AppsLocal 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.TestingUnit 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.AspNetCoreRun 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.