Questa pagina è stata tradotta automaticamente. Leggi l’originale in inglese.

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. By default the server sends nothing to Dify's vendor: infra.telemetry_enabled turns on its usage events, update check, remote template lists and Creators Platform, and infra.marketplace_enabled its plugin marketplace, which model-provider plugins such as OpenAI's install from.

Versione

1.0.01.1.0

Provenienza

UfficialeFirmato da un’identità di firma che questo catalogo riconosce come editore ufficiale.
Digest del contenuto
sha256:6cde03e895a584a1d3af008e8015aa0aefb7e52eeb6f0005dc8ccfb09107b706
Pubblicato
2026-11-15T08:08:52Z
Identità di firma
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Firma

  • Ufficialeapplication/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:ac95749c5717fc491f3efac7000fb5818ddd70e0247456c9885278be4e77d06d

Riferimento a questa versione

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

Parametri dello sviluppatore

Valori che lo sviluppatore imposta nell’Aggregate.

Estende BaseComponents#/schemas/BaseAgentParameter

NomeTipoPredefinitoObbligatorioDescrizione
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 and compose targets: 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.

Dimensionamento dell’operatore

Dimensionamento dell’infrastruttura che l’operatore regola per ogni ambiente.

NomeTipoPredefinitoObbligatorioDescrizione
portinteger (min 1024, max 65535)5001noConsole-API and application-API listen port consumers connect to.
published_portinteger (min 1024, max 65535)—noPort 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_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.
console_urlstring—noAddress a browser opens the console (core/ai-agent/dify-web) at, as scheme, host and port, for example http://127.0.0.1:3001. The server admits credentialed browser requests to its console API from this origin alone, so the console's sign-in works there, and composes the console links it hands out, such as the redirect after an OAuth sign-in, from it. A trailing / is dropped, and an address carrying any other path halts the build, since a browser sends an origin without one. Where infra.external_base_url is set too, this key decides the console's address and that one the other URLs. Unset, the console's address comes from infra.external_base_url where that is set, and otherwise is the image's own default, http://127.0.0.1:3000.
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.
telemetry_enabledbooleanfalsenoLets the server reach Dify's vendor for its anonymous usage events (otel.dify.ai, falling back to otel.dify.cn, when first-time setup runs), the update check the console makes (updates.dify.ai), the remote application and knowledge-pipeline template lists (tmpl.dify.ai) and publishing an application to the Creators Platform (creators.dify.ai). Unset or false, nothing reaches those hosts: the templates come from the image and the update check answers with the running version. Set it on the task worker and the scheduler too, which send and schedule the daily usage event.
marketplace_enabledbooleanfalsenoLets the server reach Dify's plugin marketplace (marketplace.dify.ai) to install, upgrade and look up plugins. Model-provider plugins such as OpenAI's install from the marketplace, so a Release whose applications use one sets it. Unset or false, nothing reaches that host and plugins install only from an uploaded package or from GitHub. Set it on the task worker and the scheduler too, which run the daily plugin upgrade check.
computeobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Contratto di output

Valori che questo componente pubblica verso i consumatori attraverso la topologia uses.

NomeTipoPredefinitoObbligatorioDescrizione
hoststring—sìIn-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—sìTCP 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.

Socket uses

I socket di dipendenza attraverso cui questo componente si connette. La destinazione di ogni connessione collegata attraverso un socket deve soddisfare il suo selettore di etichette, e ogni connessione può portare un aggancio negli slot che il socket dichiara. Uno slot obbligatorio deve essere riempito da ogni connessione che l’Aggregate o la Release collega attraverso il socket.

backend

Selettore
component.aggrega.ai/category=datastore
Iniezione
env

Slot che ogni connessione attraverso questo socket può riempire

SlotSelettoreObbligatorioIniezioneSensibileDescrizione
credentialfeature.aggrega.ai/kind=secretnoenvsìOptional 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

Selettore
component.aggrega.ai/category=datastore
Iniezione
env

Slot che ogni connessione attraverso questo socket può riempire

SlotSelettoreObbligatorioIniezioneSensibileDescrizione
server_cafeature.aggrega.ai/kind=secretnofilesìOptional 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 helm Recipe mounts the whole Secret read-only and points the cache client and the task broker at the file; the compose Recipe refuses it, having no Secret to mount. 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

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

Questo socket non dichiara slot di aggancio, quindi una connessione attraverso di esso non porta alcun aggancio.

sandbox

Selettore
component.aggrega.ai/category=ai-agent
Iniezione
env

Slot che ogni connessione attraverso questo socket può riempire

SlotSelettoreObbligatorioIniezioneSensibileDescrizione
credentialfeature.aggrega.ai/kind=secretnoenvsìOptional 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

Selettore
component.aggrega.ai/category=ai-agent
Iniezione
env

Slot che ogni connessione attraverso questo socket può riempire

SlotSelettoreObbligatorioIniezioneSensibileDescrizione
credentialfeature.aggrega.ai/kind=secretnoenvsìOptional 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

Selettore
component.aggrega.ai/category=ai-agent
Iniezione
env

Questo socket non dichiara slot di aggancio, quindi una connessione attraverso di esso non porta alcun aggancio.

Slot di aggancio

Punti di associazione con nome in cui una Feature si aggancia a questo componente. Il selettore di uno slot limita quale Feature può riempirlo e la sua lista inject indica come può essere consegnato il materiale della Feature. Uno slot obbligatorio deve essere associato su ogni istanza, da un aggancio sull’istanza o a un ambito superiore, e uno slot sensibile è dichiarato per gestire materiale segreto. Una Feature può anche agganciarsi con un nome che nessuno slot dichiara.

SlotSelettoreObbligatorioIniezioneSensibileDescrizione
secret_keyfeature.aggrega.ai/kind=secretsìenvsìRequired 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=secretnoenvsìOptional 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=secretnoenvsìPassword 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. On helm 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; on compose it receives the value the credential delivers, written into the emitted file as delivered, so an origin written as a Compose variable reference keeps it out of the file. Dify accepts a password of at least eight characters holding both letters and digits.

Elenco consentito di auto-iniezione

env

Relazioni

Archi tipizzati da e verso altre entità pubblicate. Un riferimento senza una destinazione pubblicata viene mostrato come arco interrotto anziché come link.

Usa

Usato da

Riferimento al concetto Component →

Il catalogo Aggrega — un indice aperto di componenti, funzionalità, ricette e dei plugin che li renderizzano.

Realizzato con il design system condiviso di Aggrega.

Privacy