# Rootprint

> Self-hosted log management documentation for operators and developers.

## Docs

- [API reference](https://docs.rootprint.io/api/overview.md): Use the Rootprint HTTP API to ingest logs, search logs from external tools, and automate administration against your own Rootprint deployment.
- [Change current user password](https://docs.rootprint.io/api/reference/authentication/change-current-user-password.md): Handled by Better Auth.
- [Create the first admin user](https://docs.rootprint.io/api/reference/authentication/create-the-first-admin-user.md)
- [Get current session](https://docs.rootprint.io/api/reference/authentication/get-current-session.md): Handled by Better Auth.
- [Get setup bootstrap state](https://docs.rootprint.io/api/reference/authentication/get-setup-bootstrap-state.md)
- [List enabled auth providers](https://docs.rootprint.io/api/reference/authentication/list-enabled-auth-providers.md)
- [Set password from invite token](https://docs.rootprint.io/api/reference/authentication/set-password-from-invite-token.md)
- [Sign in with email and password](https://docs.rootprint.io/api/reference/authentication/sign-in-with-email-and-password.md): Handled by Better Auth.
- [Sign out current session](https://docs.rootprint.io/api/reference/authentication/sign-out-current-session.md): Handled by Better Auth.
- [Verify an invite token](https://docs.rootprint.io/api/reference/authentication/verify-an-invite-token.md)
- [Delete Google auth credentials](https://docs.rootprint.io/api/reference/configure-auth/delete-google-auth-credentials.md)
- [Get Google auth settings](https://docs.rootprint.io/api/reference/configure-auth/get-google-auth-settings.md)
- [Set allowed Google auth domains](https://docs.rootprint.io/api/reference/configure-auth/set-allowed-google-auth-domains.md)
- [Set Google auth credentials](https://docs.rootprint.io/api/reference/configure-auth/set-google-auth-credentials.md)
- [Ingest NDJSON logs](https://docs.rootprint.io/api/reference/ingest-logs/ingest-ndjson-logs.md): Send newline-delimited JSON logs to the index attached to an ingest API key.
- [Ingest OTLP logs](https://docs.rootprint.io/api/reference/ingest-logs/ingest-otlp-logs.md): Send OTLP HTTP/protobuf log batches to Rootprint.
- [Create an API key](https://docs.rootprint.io/api/reference/manage-api-keys/create-an-api-key.md)
- [Delete an API key](https://docs.rootprint.io/api/reference/manage-api-keys/delete-an-api-key.md)
- [Get an API key value](https://docs.rootprint.io/api/reference/manage-api-keys/get-an-api-key-value.md)
- [List API keys](https://docs.rootprint.io/api/reference/manage-api-keys/list-api-keys.md)
- [Delete an index](https://docs.rootprint.io/api/reference/manage-indexes/delete-an-index.md)
- [Delete an index source](https://docs.rootprint.io/api/reference/manage-indexes/delete-an-index-source.md)
- [Enable or disable an index source](https://docs.rootprint.io/api/reference/manage-indexes/enable-or-disable-an-index-source.md)
- [Get current user index preferences](https://docs.rootprint.io/api/reference/manage-indexes/get-current-user-index-preferences.md)
- [Get index detail](https://docs.rootprint.io/api/reference/manage-indexes/get-index-detail.md)
- [Get index stats history](https://docs.rootprint.io/api/reference/manage-indexes/get-index-stats-history.md)
- [Get index view configuration](https://docs.rootprint.io/api/reference/manage-indexes/get-index-view-configuration.md)
- [List index fields](https://docs.rootprint.io/api/reference/manage-indexes/list-index-fields.md)
- [List indexes](https://docs.rootprint.io/api/reference/manage-indexes/list-indexes.md)
- [Update current user index preferences](https://docs.rootprint.io/api/reference/manage-indexes/update-current-user-index-preferences.md)
- [Update index display configuration](https://docs.rootprint.io/api/reference/manage-indexes/update-index-display-configuration.md)
- [Delete a user](https://docs.rootprint.io/api/reference/manage-users/delete-a-user.md)
- [Invite a user](https://docs.rootprint.io/api/reference/manage-users/invite-a-user.md)
- [List users](https://docs.rootprint.io/api/reference/manage-users/list-users.md)
- [Reissue an invite](https://docs.rootprint.io/api/reference/manage-users/reissue-an-invite.md)
- [Reset a user password](https://docs.rootprint.io/api/reference/manage-users/reset-a-user-password.md)
- [Set user role](https://docs.rootprint.io/api/reference/manage-users/set-user-role.md)
- [Get API key activity summary](https://docs.rootprint.io/api/reference/monitor-system/get-api-key-activity-summary.md)
- [Get API key latency buckets](https://docs.rootprint.io/api/reference/monitor-system/get-api-key-latency-buckets.md)
- [Get API key volume buckets](https://docs.rootprint.io/api/reference/monitor-system/get-api-key-volume-buckets.md)
- [Get cluster overview](https://docs.rootprint.io/api/reference/monitor-system/get-cluster-overview.md)
- [Get parsed Quickwit metrics](https://docs.rootprint.io/api/reference/monitor-system/get-parsed-quickwit-metrics.md)
- [Get raw Quickwit metrics](https://docs.rootprint.io/api/reference/monitor-system/get-raw-quickwit-metrics.md)
- [Get search activity summary](https://docs.rootprint.io/api/reference/monitor-system/get-search-activity-summary.md)
- [Get search latency buckets](https://docs.rootprint.io/api/reference/monitor-system/get-search-latency-buckets.md)
- [Get user search activity summary](https://docs.rootprint.io/api/reference/monitor-system/get-user-search-activity-summary.md)
- [Get user search latency buckets](https://docs.rootprint.io/api/reference/monitor-system/get-user-search-latency-buckets.md)
- [Get user search volume buckets](https://docs.rootprint.io/api/reference/monitor-system/get-user-search-volume-buckets.md)
- [List recent API key searches](https://docs.rootprint.io/api/reference/monitor-system/list-recent-api-key-searches.md)
- [List recent user searches](https://docs.rootprint.io/api/reference/monitor-system/list-recent-user-searches.md)
- [List slowest searches](https://docs.rootprint.io/api/reference/monitor-system/list-slowest-searches.md)
- [List top search actors](https://docs.rootprint.io/api/reference/monitor-system/list-top-search-actors.md)
- [List user search activity by index](https://docs.rootprint.io/api/reference/monitor-system/list-user-search-activity-by-index.md)
- [Co-aggregated field values for multiple fields in one request](https://docs.rootprint.io/api/reference/search-logs/co-aggregated-field-values-for-multiple-fields-in-one-request.md)
- [Create a log share](https://docs.rootprint.io/api/reference/search-logs/create-a-log-share.md)
- [Create a saved query](https://docs.rootprint.io/api/reference/search-logs/create-a-saved-query.md)
- [Delete a saved query](https://docs.rootprint.io/api/reference/search-logs/delete-a-saved-query.md)
- [Export matching logs](https://docs.rootprint.io/api/reference/search-logs/export-matching-logs.md)
- [Get log histogram](https://docs.rootprint.io/api/reference/search-logs/get-log-histogram.md)
- [List common values for a field](https://docs.rootprint.io/api/reference/search-logs/list-common-values-for-a-field.md)
- [List saved queries](https://docs.rootprint.io/api/reference/search-logs/list-saved-queries.md)
- [Resolve a log share](https://docs.rootprint.io/api/reference/search-logs/resolve-a-log-share.md)
- [Search logs in an index](https://docs.rootprint.io/api/reference/search-logs/search-logs-in-an-index.md)
- [Search logs with an API key](https://docs.rootprint.io/api/reference/search-logs/search-logs-with-a-search-api-key.md): Search logs from the index attached to a search API key.
- [Update a saved query](https://docs.rootprint.io/api/reference/search-logs/update-a-saved-query.md)
- [Check service health](https://docs.rootprint.io/api/reference/system-health/check-service-health.md)
- [Create a custom index](https://docs.rootprint.io/configuration/custom-indexes.md): Define a Quickwit index with your own schema, tokenizers, and retention policy — then point Rootprint at it.
- [Environment variables reference](https://docs.rootprint.io/configuration/environment-variables.md): Reference for all environment variables that control Rootprint behavior.
- [Enable Google OAuth](https://docs.rootprint.io/configuration/google-auth.md): Set up Google OAuth credentials and configure allowed email domains so your team can sign in to Rootprint using their Google accounts.
- [Manage indexes](https://docs.rootprint.io/configuration/manage-indexes.md): Inspect, configure, and delete Quickwit indexes from the Rootprint admin UI — the index list, per-index field-role mapping and visibility, fields, sources, and deletion.
- [Reset admin password](https://docs.rootprint.io/configuration/reset-admin-password.md): Recover access to the Rootprint admin account by clearing the admin users and the first-admin setup flag, then completing the setup wizard again.
- [What is Rootprint?](https://docs.rootprint.io/index.md): Rootprint is an open-source, self-hosted log management platform that allows you to run search directly on cloud storage.
- [Indexes](https://docs.rootprint.io/indexes.md): Understand how Rootprint uses Quickwit indexes to organize and query your log data.
- [Docker Compose](https://docs.rootprint.io/install/docker-compose.md): Install Rootprint with Docker Compose
- [Scaling beyond a single node](https://docs.rootprint.io/install/scaling.md): Run Rootprint with a larger Quickwit deployment, and know which parts are single-node only.
- [Get started with Rootprint in under five minutes](https://docs.rootprint.io/quickstart.md): Deploy Rootprint with Docker Compose, create an ingest API key, and send your first logs to a Quickwit index — all in under five minutes.
- [Search query syntax](https://docs.rootprint.io/search/query-language.md): Build precise log searches with Lucene query syntax — terms, phrases, ranges, booleans, and field paths.
- [Send logs over HTTP (NDJSON gateway)](https://docs.rootprint.io/send-logs/http.md): Authenticated NDJSON gateway in front of Quickwit - push logs to the index attached to your ingest API key using whatever schema that index expects.
- [Send logs from Go](https://docs.rootprint.io/send-logs/languages/go.md): Ship Go logs to Rootprint with the OpenTelemetry SDK and the slog bridge over OTLP HTTP.
- [Send logs from Node.js](https://docs.rootprint.io/send-logs/languages/javascript.md): Ship Node.js logs to Rootprint using the OpenTelemetry SDK, Pino, or Winston over OTLP HTTP.
- [Send logs from Python](https://docs.rootprint.io/send-logs/languages/python.md): Ship Python logs to Rootprint with the OpenTelemetry SDK over OTLP HTTP.
- [Send logs from Zig](https://docs.rootprint.io/send-logs/languages/zig.md): Ship Zig logs to Rootprint with the opentelemetry-sdk std.log bridge over OTLP HTTP.
- [Send logs with Fluent Bit](https://docs.rootprint.io/send-logs/log-agents/fluent-bit.md): Tail log files on a Linux host with Fluent Bit and ship them to Rootprint over OTLP.
- [Send logs with Vector](https://docs.rootprint.io/send-logs/log-agents/vector.md): Tail log files on a Linux host with Vector and ship them to Rootprint over OTLP.
- [OTLP reference](https://docs.rootprint.io/send-logs/otlp.md): Rootprint OTLP HTTP endpoint — URL, authentication, content types, limits, and response codes.
- [Send logs](https://docs.rootprint.io/send-logs/overview.md): Pick the right ingestion path: OTLP for anything OpenTelemetry, the NDJSON gateway for custom-schema indexes.
- [Send logs from Docker](https://docs.rootprint.io/send-logs/platforms/docker.md): Ship every container on a Linux host to Rootprint with a Vector sidecar that reads from the Docker daemon and emits OTLP.
- [Send Caddy logs with Vector](https://docs.rootprint.io/send-logs/web-servers/caddy.md): Tail Caddy's JSON access and error logs with Vector and ship them to Rootprint over OTLP, with the access fields mapped to OpenTelemetry HTTP semantic conventions.
- [Send nginx logs with Vector](https://docs.rootprint.io/send-logs/web-servers/nginx.md): Tail nginx's default `combined` access logs and error logs with Vector and ship them to Rootprint over OTLP, with the access fields mapped to OpenTelemetry HTTP semantic conventions.
- [Audit Linux authentication events with Vector](https://docs.rootprint.io/tutorials/linux-auth-audit-vector.md): Ship /var/log/auth.log to Rootprint with Vector and search SSH, sudo, and PAM events by user, source IP, and severity.

## OpenAPI Specs

- [openapi](https://docs.rootprint.io/api/openapi.json)