# Halite

> A modern self-hosted web console for SaltStack.

## Docs

- [List Activity Route](https://www.halite-app.com/api-reference/activity/list-activity-route.md)
- [Stream Activity Route](https://www.halite-app.com/api-reference/activity/stream-activity-route.md)
- [Widget Config Route](https://www.halite-app.com/api-reference/activity/widget-config-route.md): Read-only widget display config for any authenticated user. The full admin settings are gated behind ``settings:*``, but the Overview widget is shown to every user — so this exposes only the 7 display fields.
- [List Audit](https://www.halite-app.com/api-reference/audit/list-audit.md)
- [Change Password Route](https://www.halite-app.com/api-reference/auth/change-password-route.md)
- [Login Route](https://www.halite-app.com/api-reference/auth/login-route.md)
- [Logout Route](https://www.halite-app.com/api-reference/auth/logout-route.md)
- [Me Route](https://www.halite-app.com/api-reference/auth/me-route.md)
- [Compliance Route](https://www.halite-app.com/api-reference/fleet/compliance-route.md)
- [Fleet Health Route](https://www.halite-app.com/api-reference/fleet/fleet-health-route.md)
- [Run Detail Route](https://www.halite-app.com/api-reference/fleet/run-detail-route.md)
- [Top Failures Route](https://www.halite-app.com/api-reference/fleet/top-failures-route.md)
- [Healthz](https://www.halite-app.com/api-reference/healthz.md)
- [List Packages Route](https://www.halite-app.com/api-reference/inventory/list-packages-route.md): Fleet-wide aggregate: one row per package name. Default landing view.
- [List Versions Route](https://www.halite-app.com/api-reference/inventory/list-versions-route.md): All distinct versions of one named package, with per-version minion counts.
- [Refresh Route](https://www.halite-app.com/api-reference/inventory/refresh-route.md)
- [Search Packages Route](https://www.halite-app.com/api-reference/inventory/search-packages-route.md): Row-level package search. Used by level 3 (minions with one specific name+version) and as a power-user query endpoint (version comparison, multi-field filter).
- [Get Job Route](https://www.halite-app.com/api-reference/jobs/get-job-route.md)
- [Jobs Activity Route](https://www.halite-app.com/api-reference/jobs/jobs-activity-route.md)
- [Jobs Timeline Route](https://www.halite-app.com/api-reference/jobs/jobs-timeline-route.md)
- [Kill Job Route](https://www.halite-app.com/api-reference/jobs/kill-job-route.md)
- [List Jobs Route](https://www.halite-app.com/api-reference/jobs/list-jobs-route.md)
- [Accept Key Route](https://www.halite-app.com/api-reference/keys/accept-key-route.md)
- [Delete Key Route](https://www.halite-app.com/api-reference/keys/delete-key-route.md)
- [List Keys Route](https://www.halite-app.com/api-reference/keys/list-keys-route.md)
- [Reject Key Route](https://www.halite-app.com/api-reference/keys/reject-key-route.md)
- [Get Minion Route](https://www.halite-app.com/api-reference/minions/get-minion-route.md)
- [List Minion Compliance Route](https://www.halite-app.com/api-reference/minions/list-minion-compliance-route.md)
- [List Minion Runs Route](https://www.halite-app.com/api-reference/minions/list-minion-runs-route.md)
- [List Minions Route](https://www.halite-app.com/api-reference/minions/list-minions-route.md)
- [Readyz](https://www.halite-app.com/api-reference/readyz.md)
- [Add Permission Route](https://www.halite-app.com/api-reference/roles/add-permission-route.md)
- [Create Role Route](https://www.halite-app.com/api-reference/roles/create-role-route.md)
- [Delete Role Route](https://www.halite-app.com/api-reference/roles/delete-role-route.md)
- [Get Role Route](https://www.halite-app.com/api-reference/roles/get-role-route.md)
- [List Roles Route](https://www.halite-app.com/api-reference/roles/list-roles-route.md)
- [Remove Permission Route](https://www.halite-app.com/api-reference/roles/remove-permission-route.md)
- [Update Role Route](https://www.halite-app.com/api-reference/roles/update-role-route.md)
- [Run Command Route](https://www.halite-app.com/api-reference/run/run-command-route.md)
- [List Functions Route](https://www.halite-app.com/api-reference/salt-docs/list-functions-route.md): List the names of execution functions the salt master knows about.
- [Get Route](https://www.halite-app.com/api-reference/settings/get-route.md)
- [Put Logging Route](https://www.halite-app.com/api-reference/settings/put-logging-route.md)
- [Put Pollers Route](https://www.halite-app.com/api-reference/settings/put-pollers-route.md)
- [Put Salt Route](https://www.halite-app.com/api-reference/settings/put-salt-route.md)
- [Put Widget Route](https://www.halite-app.com/api-reference/settings/put-widget-route.md)
- [Status Route](https://www.halite-app.com/api-reference/settings/status-route.md)
- [Test Salt Route](https://www.halite-app.com/api-reference/settings/test-salt-route.md): Throwaway client. Validates creds without persisting.
- [Test Salt Saved Route](https://www.halite-app.com/api-reference/settings/test-salt-saved-route.md): Test the credentials currently persisted in the DB. Used by the settings page when the operator hasn't re-typed the password — we can't roundtrip it through the form (security), but we can still validate it server-side.
- [Create Template Route](https://www.halite-app.com/api-reference/templates/create-template-route.md)
- [Delete Template Route](https://www.halite-app.com/api-reference/templates/delete-template-route.md)
- [List Templates Route](https://www.halite-app.com/api-reference/templates/list-templates-route.md)
- [Update Template Route](https://www.halite-app.com/api-reference/templates/update-template-route.md)
- [Add User Role Route](https://www.halite-app.com/api-reference/users/add-user-role-route.md)
- [Create User Route](https://www.halite-app.com/api-reference/users/create-user-route.md)
- [Delete User Route](https://www.halite-app.com/api-reference/users/delete-user-route.md)
- [Get User Route](https://www.halite-app.com/api-reference/users/get-user-route.md)
- [List User Roles Route](https://www.halite-app.com/api-reference/users/list-user-roles-route.md)
- [List Users Route](https://www.halite-app.com/api-reference/users/list-users-route.md)
- [Remove User Role Route](https://www.halite-app.com/api-reference/users/remove-user-role-route.md)
- [Reset Password Route](https://www.halite-app.com/api-reference/users/reset-password-route.md)
- [Update User Route](https://www.halite-app.com/api-reference/users/update-user-route.md)
- [API Overview](https://www.halite-app.com/api/introduction.md): Authenticate and call the Halite API.
- [Audit Logging](https://www.halite-app.com/concepts/audit-log.md): Every authorization decision is recorded.
- [Authentication & Sessions](https://www.halite-app.com/concepts/authentication.md): Signed-cookie sessions and the bootstrap admin.
- [How Halite Works](https://www.halite-app.com/concepts/how-it-works.md): The poll-into-DB architecture and graceful degradation.
- [RBAC & Permissions](https://www.halite-app.com/concepts/rbac.md): Roles, verb:resource permission globs, and how checks resolve.
- [Configuration](https://www.halite-app.com/configuration.md): Environment variables and in-app settings.
- [Installation & Deployment](https://www.halite-app.com/deployment.md): Deploy Halite with Postgres or SQLite, behind a TLS proxy.
- [Regenerating the API Spec](https://www.halite-app.com/develop/api-spec.md): Keep the API reference in sync with the backend.
- [Architecture](https://www.halite-app.com/develop/architecture.md): Backend/frontend split and the RuntimeConfig hub.
- [Backend](https://www.halite-app.com/develop/backend.md): Feature modules, RuntimeConfig, SaltAPIClient, and schedulers.
- [Database & Migrations](https://www.halite-app.com/develop/database.md): Dual-backend portability and Alembic.
- [Frontend](https://www.halite-app.com/develop/frontend.md): React 19, TanStack, shadcn/ui, and generated API types.
- [Local Development](https://www.halite-app.com/develop/local-development.md): Run the backend and frontend locally.
- [Testing](https://www.halite-app.com/develop/testing.md): pytest dual-backend, vitest, lint, and build.
- [About](https://www.halite-app.com/features/about.md): The in-app colophon and brand story.
- [Activity](https://www.halite-app.com/features/activity.md): A live feed of Salt event-bus activity — jobs, keys, and minions.
- [Audit Log](https://www.halite-app.com/features/audit.md): Query the authorization audit trail.
- [Fleet Health](https://www.halite-app.com/features/fleet.md): Highstate compliance and fleet health.
- [Inventory](https://www.halite-app.com/features/inventory.md): Package inventory across the fleet.
- [Jobs](https://www.halite-app.com/features/jobs.md): Browse jobs, inspect results, and kill running jobs.
- [Keys](https://www.halite-app.com/features/keys.md): Accept, reject, or delete minion keys.
- [Minions](https://www.halite-app.com/features/minions.md): Live minion status and grains.
- [Overview](https://www.halite-app.com/features/overview.md): Dashboard KPIs and fleet activity charts.
- [Run](https://www.halite-app.com/features/run.md): Dispatch Salt execution-module functions against any target.
- [Settings](https://www.halite-app.com/features/settings.md): Configure the Salt-API connection and pollers.
- [Command Templates](https://www.halite-app.com/features/templates.md): Save and share reusable Run commands.
- [Timeline](https://www.halite-app.com/features/timeline.md): A visual, at-a-glance grid of recent job activity over a time window.
- [Users & Roles](https://www.halite-app.com/features/users-roles.md): Manage users, roles, and permissions.
- [Halite](https://www.halite-app.com/index.md)
- [Quickstart](https://www.halite-app.com/quickstart.md): Run Halite locally with Docker in a few minutes.

## OpenAPI Specs

- [openapi](https://www.halite-app.com/api/openapi.json)