Component
core/ai-agent/librechat
A self-hosted LibreChat installation — the browser platform a person holds conversations in, and the tier that turns a bare model endpoint into a working assistant surface. It reaches its model through the `model` uses-socket and adds agents an author assembles without writing code, tool invocation over the tool servers an administrator registers, a code interpreter, and retrieval over files a user uploads. Every agent run, a delegated child run included, is entered from a conversation a person started: the platform runs no background loop of its own. Its accounts, conversations, agents and stored per-user credentials live in a document store wired through the `backend` socket, the system of record; only uploaded files sit on a volume of its own. A store that requires a sign-in, as FerretDB does by default, takes the user and password from the credential attached on that connection. The two token-signing secrets and the credential-encryption pair decide what its sign-ins and stored credentials are worth, and each has a slot of its own. None of the four has a default, and the build halts until each slot is filled. On Kubernetes, reach for `librechat-chart`, rendering the project's own chart, where a chart repository is reachable at build time, and for `librechat`, the workload synthesis, where the build must fetch nothing. With `values.metrics_enabled` true each Recipe turns on the platform's Prometheus metrics, at /metrics on its port and answered only to a bearer token equal to the secret attached to metrics_secret, and publishes the address as `metrics_endpoint`; a scrape presents that secret on its connection's `credential` slot.
Provenance
- Content digest
- sha256:df8acd69b138eb9e74cf3bf6b7819fe1bc5350bc21a667c476305317f2d5fe24
- Published
- 2026-11-15T08:08:55Z
- Signing identity
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Signature
- Officialapplication/vnd.dev.sigstore.bundle.v0.3+json
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
sha256:ce3140ba588b7ddc4c67693ef09346ac88b32a6c5db49609981eb6a0d03e753e
Reference at this version
oci://hub.aggrega.ai/component/core/ai-agent/librechat:1.2.0Developer parameters
Values the developer sets in the Aggregate.
Extends BaseComponents#/schemas/BaseAgentParameter
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| app_title | string | LibreChat | no | Name the platform presents in the browser title and the interface header. Two installations reachable by the same people tell themselves apart by carrying different titles. |
| database_name | string | LibreChat | no | Name of the logical database the platform uses inside the wired document store. Two installations sharing one store keep their data apart by carrying different names. |
| allow_registration | boolean | false | no | Whether a visitor who is not yet a user may create an account from the sign-in page. Left off, accounts are created only by an administrator, which is the posture an installation reachable beyond its own team wants. |
| metrics_enabled | boolean | false | no | Turns on LibreChat's own metrics, in the Prometheus format, at /metrics on the platform's port, and publishes their address as `metrics_endpoint`; while false that key is empty. The platform answers them only to the secret attached to metrics_secret, presented as a bearer token, so the build halts when this is true and that slot is unfilled. They carry request counts and timings, never a user's or conversation's identifier or content. |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 3080 | no | Listen port the platform serves its interface and API on, and the port consumers connect to. Most operators should omit this and let the Recipe assign the default (3080). |
| published_port | integer (min 1024, max 65535) | — | no | Port published on the host's loopback address, 127.0.0.1, on Docker Compose, forwarding to infra.port inside the container; any process on this machine can reach it there. Unset, nothing is published. Kubernetes realizations refuse it; reach the Service with kubectl port-forward, or attach core/public-ingress. |
| engine_version | string | v0.8.7 | no | LibreChat container image tag. Selects the image tag of the platform container on both Recipes. |
| source_version | string | — | no | Version of the platform's own Helm chart the chart-backed Recipe pulls, defaulting to the version that Recipe was checked against. The workload-synthesis Recipe pulls no chart and reads nothing here. |
| storage | object | — | no | — |
| external_base_url | string | no | Externally reachable base URL of the installation, as a browser sees it — the address the ingress tier publishes. The platform composes the links it emits from it and accepts browser requests against it. Left empty, the Kubernetes Recipes supply the installation's own in-cluster address instead, which suits an installation reached only in-cluster, and the Docker Compose Recipe http://localhost:<port>; where infra.published_port differs from infra.port there, set this to http://127.0.0.1:<published_port>. | |
| compute | object | — | no | — |
| overrides | object (open) | — | no | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Output contract
Values this component publishes to consumers over the uses topology.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| host | string | — | yes | In-cluster DNS name of the Service serving the chat interface and its API. The ingress tier points its upstream at this name. |
| port | integer | — | yes | TCP port that Service serves the interface and API on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default. |
| protocol | string | — | no | URL scheme to reach `host` and `port` over, which a consumer composes its base URL on. |
| metrics_endpoint | string | — | no | The full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:<port>/metrics`, on the port the interface is served on. Empty while values.metrics_enabled is false. |
| metrics_credential_required | boolean | — | no | Whether a scrape of `metrics_endpoint` must present a credential: true while values.metrics_enabled is true, because the platform answers its metrics only to the secret attached to metrics_secret, which a scrape presents on its connection's `credential` slot; false while no address is published. |
Uses sockets
The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.
model
- Selector
- component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api
- Inject
- —
Slots each connection through this socket may fill
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | no | env | yes | Optional credential the platform presents to the model this connection reaches. Unattached, the Recipe leaves the platform in its per-user mode, where each person enters their own key in the interface and no key is rendered at all. |
backend
- Selector
- component.aggrega.ai/category=datastore
- Inject
- —
Slots each connection through this socket may fill
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | no | env | yes | Optional sign-in the platform presents to the document store this connection reaches, written as <user>:<password> with any reserved URL character in either part percent-encoded, since it becomes the user-information part of the connection string. Unattached, the connection string carries no user part. |
Attachment slots
Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| session_secret | feature.aggrega.ai/kind=secret | yes | env | yes | Required secret the platform signs its access tokens with. There is no default: the build halts when nothing fills this slot. Blanking the variable instead, so the platform generates one for itself, is a bootstrap convenience rather than a credential-rotation system: the generated value does not survive a restart and a second replica generates a different one, and each change invalidates every session then active. |
| session_refresh_secret | feature.aggrega.ai/kind=secret | yes | env | yes | Required secret the platform signs its refresh tokens with — the tokens a browser presents to mint a new access token, so it carries the weight of the access-token secret. There is no default: the build halts when nothing fills this slot. Blanking the variable instead, so the platform generates one for itself, is a bootstrap convenience rather than a credential-rotation system: the generated value does not survive a restart and a second replica generates a different one, and each change makes every person sign in again. |
| credential_encryption_key | feature.aggrega.ai/kind=secret | yes | env | yes | Required key the platform encrypts the credentials it stores in the document store under, as 64 hexadecimal characters (a 32-byte key). It encrypts the credentials it supports whether or not the people using the installation ever save one of their own, so this slot is filled even where the model key is supplied centrally. There is no default: the build halts when nothing fills this slot. Blanking the variable instead, so the platform generates one for itself, is a bootstrap convenience rather than a credential-rotation system: the generated value does not survive a restart and a second replica generates a different one, and each change leaves everything already stored undecryptable. |
| credential_encryption_iv | feature.aggrega.ai/kind=secret | yes | env | yes | Required initialization vector the platform pairs with the credential-encryption key when it encrypts what it stores, as 32 hexadecimal characters (16 bytes). A vector is not secret by cryptographic design, but one every reader of this catalog held would be the same in every Release, so there is no default: the build halts when nothing fills this slot. Blanking the variable instead, so the platform generates one for itself, is a bootstrap convenience rather than a credential-rotation system: the generated value does not survive a restart and a second replica generates a different one, and each change leaves everything already stored undecryptable. |
| metrics_secret | feature.aggrega.ai/kind=secret | no | env | yes | Optional secret the platform answers its Prometheus metrics to: a scrape presents it as a bearer token, on its connection's credential slot. It is delivered as METRICS_SECRET only while values.metrics_enabled is true, and is required then: the build halts when the value is true and nothing fills this slot. There is no default. While the value is false it is not delivered, and the platform answers its metrics route 401 to every caller. |
Self-inject allowlist
No self-inject pipes declared.
Relationships
Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.
Uses
- usesuses socket «model»
component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api
Attachment slots: credential
core/ai-model/ai21 v1.0.0 →core/ai-model/anthropic v1.0.0 →core/ai-model/azure-managed v1.0.0 →core/ai-model/azure-openai v1.0.0 →core/ai-model/azure-openai-embedding v1.0.0 →core/ai-model/bedrock v1.0.0 →core/ai-model/bedrock-embedding v1.0.0 →core/ai-model/cohere v1.0.0 →core/ai-model/databricks v1.0.0 →core/ai-model/docker-model-runner v1.0.0 →core/ai-model/gemini v1.0.0 →core/ai-model/huggingface v1.0.0 →core/ai-model/litellm v1.0.0 →core/ai-model/mistral v1.0.0 →core/ai-model/nvidia-api v1.0.0 →core/ai-model/nvidia-nim v1.0.0 →core/ai-model/ollama v1.0.0 →core/ai-model/openai v1.0.0 →core/ai-model/openai-compatible v1.0.0 →core/ai-model/openai-embedding v1.0.0 →core/ai-model/replicate v1.0.0 →core/ai-model/sagemaker v1.0.0 →core/ai-model/tei v1.0.0 →core/ai-model/tgi v1.0.0 →core/ai-model/vertex-ai v1.0.0 →core/ai-model/vertex-ai-embedding v1.0.0 →core/ai-model/vllm v1.0.0 →core/gateway/agentgateway v1.0.0 →core/gateway/apisix v1.0.0 →core/gateway/envoy-gateway v1.0.0 →core/gateway/higress v1.0.0 →core/gateway/kong v1.0.0 →core/gateway/kong-enterprise v1.0.0 →core/gateway/litellm v1.0.0 →core/gateway/traefik-hub v1.0.0 → - usesuses socket «backend»
component.aggrega.ai/category=datastore
Attachment slots: credential
core/datastore/chroma v1.0.0 →core/datastore/cognee v1.0.0 →core/datastore/documentdb v1.0.0 →core/datastore/elasticsearch v1.0.0 →core/datastore/etcd v1.0.0 →core/datastore/ferretdb v1.0.0 →core/datastore/mariadb v1.0.0 →core/datastore/mariadb-operator v1.0.0 →core/datastore/memcached v1.0.0 →core/datastore/milvus v1.0.0 →core/datastore/mysql v1.0.0 →core/datastore/mysql-innodb-cluster v1.0.0 →core/datastore/mysql-operator v1.0.0 →core/datastore/opensearch v1.0.0 →core/datastore/pgvector v1.0.0 →core/datastore/postgres v1.0.0 →core/datastore/qdrant v1.0.0 →core/datastore/redis v1.0.0 →core/datastore/timescaledb v1.0.0 →core/datastore/valkey v1.0.0 →core/datastore/weaviate v1.0.0 → - $refextends schema (values)
BaseComponents#/schemas/BaseAgentParameter
Used by
uses socket «runner»
uses socket «api»
uses socket «runner»
uses socket «api»
uses socket «services»
uses socket «api»
uses socket «services»
uses socket «services»
uses socket «sandbox»
uses socket «plugin_daemon»
uses socket «ssrf_proxy»
uses socket «sandbox»
uses socket «plugin_daemon»
uses socket «ssrf_proxy»
uses socket «api»
uses socket «ssrf_proxy»
uses socket «api»
uses socket «api»
uses socket «sandbox»
uses socket «plugin_daemon»
uses socket «ssrf_proxy»
uses socket «sandbox»
uses socket «plugin_daemon»
uses socket «ssrf_proxy»
uses socket «target_agent»
uses socket «upstream»
uses socket «forward_target»
uses socket «scrape_target»
uses socket «store»
applies to
applies to
applies to
applies to
applies to
applies to
applies to
implements
implements
implements