Skip to main content

Providers

A provider is what bridges ARender with an external document repository. It is responsible for retrieving document content from an external system and making it available to the viewer.

Providers are standalone REST microservices. Each provider runs as its own Docker container, independent of the viewer.

A provider:

  1. Runs as a separate service that exposes a REST API for document retrieval.
  2. Receives requests from the Document Service Broker, which routes them based on the X-Provider-ID header which is injected by the reverse proxy layer (Nginx, BFF).
  3. Returns document content via REST resources (ProviderFile / ProviderFolder).

This model decouples providers from the viewer, allowing each one to be deployed, scaled, and updated independently.

See Providers for deployment details.

Annotation connectors

Annotation storage is handled by the broker, which proxies annotation CRUD operations to the provider when the repository supports it. The annotation backend (JDBC, XFDF, REST, or repository-native) is configured on the broker side.

See Annotations for the annotation model.