nutrient-document-engine

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Nutrient Document Engine

Self-hosted, on-premises document processing server. Provides the same core operations as Nutrient DWS but runs in the user's own infrastructure. Also backs the Nutrient Web SDK's server-backed mode — handling persistent annotation storage and Nutrient Instant real-time collaboration.

自托管、本地部署的文档处理服务器。提供与Nutrient DWS相同的核心操作，但运行在用户自己的基础设施中。同时为Nutrient Web SDK的服务器支持模式提供后端服务——处理持久化注释存储和Nutrient Instant实时协作。

Documentation

文档

Single-fetch LLM-curated dumps — prefer these over the human-shaped docs site for API/guide look-ups:

Guides: https://www.nutrient.io/guides/document-engine/llms.txt
Cross-product index (other Nutrient SDKs): https://www.nutrient.io/llms.txt

单次获取LLM整理的转储文件——在查询API或指南时，优先使用这些文件而非人工维护的文档站点：

指南：https://www.nutrient.io/guides/document-engine/llms.txt
跨产品索引（其他Nutrient SDK）：https://www.nutrient.io/llms.txt

Example Repositories

示例仓库

Node.js + Docker Compose (Nutrient Document Engine + Nutrient Web SDK): https://github.com/PSPDFKit/pspdfkit-server-example-nodejs
Rails + Docker Compose (Nutrient Document Engine + Nutrient Web SDK): https://github.com/PSPDFKit/pspdfkit-server-example-rails
Web examples catalog with Nutrient Document Engine (dashboard at localhost:5000): https://github.com/PSPDFKit/pspdfkit-web-examples-catalog
MCP server exposing Nutrient Document Engine capabilities to AI agents: https://github.com/PSPDFKit/nutrient-document-engine-mcp-server

Node.js + Docker Compose（Nutrient Document Engine + Nutrient Web SDK）：https://github.com/PSPDFKit/pspdfkit-server-example-nodejs
Rails + Docker Compose（Nutrient Document Engine + Nutrient Web SDK）：https://github.com/PSPDFKit/pspdfkit-server-example-rails
包含Nutrient Document Engine的Web示例目录（仪表盘位于localhost:5000）：https://github.com/PSPDFKit/pspdfkit-web-examples-catalog
向AI代理暴露Nutrient Document Engine功能的MCP服务器：https://github.com/PSPDFKit/nutrient-document-engine-mcp-server

Key Concepts

核心概念

Docker image:
```
pspdfkit/document-engine
```
on Docker Hub.
License activation: set
```
ACTIVATION_KEY
```
(or the alias
```
LICENSE_KEY
```
— either works). The pre-rebrand
```
PSPDFKIT_LICENSE_KEY
```
is not the current name; the engine fails on startup with "No
```
ACTIVATION_KEY
```
or
```
LICENSE_KEY
```
set" if missing.
Nutrient Instant: real-time collaboration backbone shared across the Nutrient client SDKs (Web, iOS, Android, React Native, Flutter). Enable in Document Engine config and point the client at the engine URL.
Document Engine vs Nutrient DWS: Document Engine runs on the user's infrastructure (no data leaves the environment); Nutrient DWS is Nutrient's hosted cloud service. Use Document Engine when data residency or offline operation is required.

Docker镜像：Docker Hub上的
```
pspdfkit/document-engine
```
。
许可证激活：设置
```
ACTIVATION_KEY
```
（或别名
```
LICENSE_KEY
```
——两者均可）。更名前的
```
PSPDFKIT_LICENSE_KEY
```
已不再是当前使用的名称；若未设置，引擎启动时会报错：“No
```
ACTIVATION_KEY
```
or
```
LICENSE_KEY
```
set”。
Nutrient Instant：Nutrient各客户端SDK（Web、iOS、Android、React Native、Flutter）共享的实时协作基础架构。在Document Engine配置中启用，并将客户端指向引擎URL。
Document Engine vs Nutrient DWS：Document Engine运行在用户的基础设施中（数据不会离开环境）；Nutrient DWS是Nutrient的托管云服务。当需要数据驻留或离线操作时，请使用Document Engine。