Component

core/ai-agent/dify

The Dify API and console server — the control plane of a self-hosted Dify installation. It serves the console API the browser front end calls, the published application API, and the file endpoints, and it owns the platform's relational model: workspaces, applications, workflow definitions, datasets and the encrypted model-provider credentials. It stores that model in a PostgreSQL backend wired through the `backend` uses-socket, keeps sessions and the Celery task queue in a Redis-compatible cache wired through `cache`, and reads and writes dataset embeddings in a vector datastore wired through `vector_store`. Three sibling services complete the platform and reach it through their own sockets: code nodes execute in the sandbox wired through `sandbox`, model and tool plugins run in the plugin runtime wired through `plugin_daemon`, and outbound requests to addresses a user supplied are routed through the forward proxy wired through `ssrf_proxy`, so a workflow cannot reach a private address directly. Holds no durable state of its own — the backend, the cache and the vector datastore are the systems of record — so it renders as a stateless server. Exports its host, port and protocol to consumers via the uses topology. An application written in Dify's own export format, set as app_definition, is imported into the installation at deploy under the owner account the operator names.

Version

1.0.01.1.0

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:9934ad23e2257de50668185805cec5cca8464cbd259c8c1be033b87b904d84d2
Published
2026-11-10T10:07:57Z
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:3b4123cad4b6844c96e70344448c245ffa5af8d97df01b59545c1919ac0684f2

Reference at this version

oci://hub.aggrega.ai/component/core/ai-agent/dify:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

Extends BaseComponents#/schemas/BaseAgentParameter

NameTypeDefaultRequiredDescription
vector_index_prefixstringVector_indexnoName prefix the platform gives the collections it creates in the wired vector datastore. Two installations sharing one datastore keep their collections apart by carrying different prefixes.
top_k_maxinteger (min 1)10noHighest retrieval top-k an application in this installation may request.
max_parallel_limitinteger (min 1)10noHighest parallel-branch count a workflow in this installation may run.
max_iterationsinteger (min 1)99noHighest iteration count an iteration node in this installation may run.
max_toolsinteger (min 1)10noHighest number of tools an agent in this installation may be given.
indexing_max_segmentation_tokensinteger (min 1)4000noLongest segment, in tokens, the dataset indexer produces when it splits a document.
app_definitionstring—noAn application in Dify's own DSL, the YAML Dify exports for an application, carried verbatim. Realized by the helm target: when set, a one-shot step imports it once the installation is deployed. The step performs Dify's first-time setup if it has not run, creating the owner account named by infra.owner_email with the password attached to the owner_password slot; signs in as that account; leaves an application already present under the definition's app.name as it is; and otherwise imports the definition through Dify's console import, confirming the import when Dify holds it for confirmation, as it does for a DSL version newer than the installation's. When set, infra.owner_email and the owner_password slot are required and the build halts without them. When unset, nothing is imported and no step is rendered. An Aggregate's text is evaluated as a template before it is read, so a definition carrying Dify's own {{#...#}} variable references halts the build when written into an Aggregate as it stands; supply it as a parameter the Release fills, written into this value through toJson, and it arrives as written.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)5001noConsole-API and application-API listen port consumers connect to.
engine_versionstring1.17.0noDify API container image tag. The worker, the scheduler and this server run the same image, so a Release moves all three together.
log_levelstring (DEBUG | INFO | WARNING | ERROR | CRITICAL)INFOnoLog verbosity the server emits.
external_base_urlstringnoExternally reachable base URL of the installation, as a browser and an API client see it — the address the ingress tier publishes. The server composes the console, application, service-API and file URLs from it, which is what makes shared links and emailed links resolve. Left empty, the server derives each URL from the incoming request, which suits an installation reached only in-cluster.
owner_emailstring—noEmail address of the installation's owner account, read only when values.app_definition is set. The step that imports the application creates this account when it performs Dify's first-time setup, and signs in as it; on an installation whose setup has already run, it names an existing account allowed to import applications, and the password attached to the owner_password slot is that account's. Required when values.app_definition is set: the build halts when it is empty. It has no default.
computeobject—no—
overridesobject (open)—noProvider-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.

NameTypeDefaultRequiredDescription
hoststring—yesIn-cluster DNS name of the Service fronting the console and application APIs. The front end and the workers dial this name for every piece of data they show or act on.
portinteger—yesTCP port that Service accepts API requests on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
protocolstring—noURL scheme to reach `host` and `port` over, which a consumer composes its base URL on.

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.

backend

Selector
component.aggrega.ai/category=datastore
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretnoenvyesOptional password the server presents to the backend this connection reaches, shared with that backend. When attached, supplies the backend password via the credential subsystem; unattached, the Recipe uses the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password.

cache

Selector
component.aggrega.ai/category=datastore
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
server_cafeature.aggrega.ai/kind=secretnofileyesOptional authority the server checks the cache's certificate against while the cache publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Recipe mounts the whole Secret read-only and points the cache client and the task broker at the file. The build halts on a server_ca publishing no Secret name, and on one wired to a cache served without TLS. Fill it with core/referenced-secret.

vector_store

Selector
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Inject
env

This socket declares no attachment slots, so a connection through it carries no attachment.

sandbox

Selector
component.aggrega.ai/category=ai-agent
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretnoenvyesOptional execution-key credential the server presents on every request to the sandbox this connection reaches. The same credential is attached to the code_execution_key slot on the sandbox, so both ends hold the same value. Unattached, the Recipe uses the pinned development literal `dify-sandbox`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.

plugin_daemon

Selector
component.aggrega.ai/category=ai-agent
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretnoenvyesOptional credential the server presents on every call it makes to the plugin runtime this connection reaches. The runtime holds the same key in its plugin_daemon_key slot and the task worker presents it on its own connection, so the credential is attached to all three or to none: attaching it to some of them leaves the rest carrying a different value, which renders cleanly and is refused when the call is made. Unattached, the Recipe uses the pinned development literal `dify-plugin-daemon-server-key`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.

ssrf_proxy

Selector
component.aggrega.ai/category=ai-agent
Inject
env

This socket declares no attachment slots, so a connection through it carries no attachment.

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.

SlotSelectorRequiredInjectSensitiveDescription
secret_keyfeature.aggrega.ai/kind=secretyesenvyesRequired application-secret credential. The server signs session cookies with it and encrypts stored model-provider credentials under it, and the task worker decrypts them with the same secret. There is no default: the build halts when nothing fills this slot.
inner_api_keyfeature.aggrega.ai/kind=secretnoenvyesOptional credential the plugin runtime presents on every call back into the server's internal API, which the server compares against its own. The server and the task worker declare this slot under the same name and the plugin runtime presents it on its connection to the server, so the credential is attached to all three or to none: attaching it to some of them leaves the rest carrying a different value, which renders cleanly and is refused when the call is made. Unattached, the Recipe uses the pinned development literal `dify-plugin-inner-api-key`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.
owner_passwordfeature.aggrega.ai/kind=secretnoenvyesPassword of the owner account named by infra.owner_email, read only when values.app_definition is set: the step that imports the application at deploy sets it when it performs Dify's first-time setup, and signs in with it. Required then, and the build halts when nothing fills this slot; there is no development default. The step receives it by reference, as a Kubernetes secretKeyRef to the Secret the credential publishes, so the password appears in no file the Recipe renders, and a credential publishing no Secret name and data key halts the build. Dify accepts a password of at least eight characters holding both letters and digits.

Self-inject allowlist

env

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

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy