Skip to main content
Version: v2023.18.0

Installation

ARender can be deployed in Docker Mode, where each component of the platform is packaged into lightweight OCI-compliant containers.
This mode is ideal for quick setup, demo environments, POCs, or small single-host deployments.

It provides faster installation and easier upgrades compared to the standalone mode, while remaining simpler than Kubernetes.


1. When to Use Docker Mode

Docker Mode is recommended when:

  • You need a simple single-host deployment
  • You want to test ARender without full infrastructure
  • You want to avoid installing Java or native dependencies manually
  • You work in a development, demo or sandbox environment

Docker Mode is not suitable for:

  • High availability
  • Multi-node deployments
  • Production workloads requiring orchestration
  • Auto-restart policies or rolling updates

If you need HA or scalability, see:
👉 Kubernetes Deployment


2. Supported Container Platforms

ARender Docker images are OCI-compliant and compatible with the following environments:

PlatformStatus
Docker Engine✔️ Supported
Docker Desktop (Windows / macOS)✔️ Supported
containerd✔️ Supported

Docker is the primary QA validation platform for container deployments.


3. Requirements

Host Requirements

Requirements for a deployment with one container per ARender service on a single host.

ComponentRequirement
CPU4+ vCPUs
RAM8-16 GB
DiskThe maximum between 20Go and a storage where a full day of temporary files can be stored
OSAny OS supporting Docker Engine

Networking

The below ports must be available on the host:

PortService
8761Broker
8899Text Handler
9091Renderer
19999Converter

4. ARender Docker Registry

ARender images are hosted on the private ARender Docker Registry.

Login:

docker login artifactory.arondor.cloud:5001

Credentials are provided by Uxopian Software.


5. Available Images

Below is the list of all ARender images available on the registry.

Rendition Images

All Rendition images are mandatory.

ComponentRepositoryVersion Tag PatternDescription
Brokerarender-document-service-broker2023.18.0Entry-point service that receives requests from the HMI or batch jobs and dispatches them to internal services
Rendererarender-document-renderer2023.18.0Generates page images
Text Handlerarender-document-text-handler2023.18.0Extracts text and its coordinates
Converterarender-document-converter2023.18.0Converts non-PDF/non-MP4 documents into PDF or MP4

Web UI Images

VariantRepositoryVersion Tag PatternDescription
Default Web UIarender-ui-springboot2023.18.0Standard GWT UI
Alfresco Web UIarender-ui-springboot2023.18.0-alfrescoStandard GWT UI with Alfresco connector
FileNet Web UIarender-ui-springboot2023.18.0-filenetStandard GWT UI with IBM FileNet connector

All Web-UI variants rely on the same base runtime.


6. Pulling Images

Use the following command to pull ARender images.

docker pull artifactory.arondor.cloud:5001/<Repository>:<Version Tag Pattern>

ARender provides a ready-to-use docker-compose.yml that includes:

  • Web UI
  • Broker
  • Renderer
  • Text Handler
  • Converter
docker-compose.yml
services:
ui:
image: artifactory.arondor.cloud:5001/arender-ui-springboot:${VERSION}
container_name: ui
environment:
- "ARENDERSRV_ARENDER_SERVER_RENDITION_HOSTS=http://dsb-service:8761/"
ports:
- 8080:8080

service-broker:
image: artifactory.arondor.cloud:5001/arender-document-service-broker:${VERSION}
container_name: dsb-service
environment:
- "DSB_KUBEPROVIDER_KUBE.HOSTS_DCV-SERVICE=19999"
- "DSB_KUBEPROVIDER_KUBE.HOSTS_DRN-SERVICE=9091"
- "DSB_KUBEPROVIDER_KUBE.HOSTS_DTH-SERVICE=8899"
ports:
- 8761:8761
volumes:
- arender-tmp:/arender/tmp

document-renderer:
image: artifactory.arondor.cloud:5001/arender-document-renderer:${VERSION}
container_name: drn-service
environment:
- "DRN_EUREKA_INSTANCE_METADATA.MAP_HOST.NAME=drn-service"
- "DRN_EUREKA_INSTANCE_HOSTNAME=dsb-service"
- "DRN_EUREKA_SERVER_PORT=8761"
ports:
- 9091:9091
volumes:
- arender-tmp:/arender/tmp

document-text-handler:
image: artifactory.arondor.cloud:5001/arender-document-text-handler:${VERSION}
container_name: dth-service
environment:
- "DTH_EUREKA_INSTANCE_METADATA.MAP_HOST.NAME=dth-service"
- "DTH_EUREKA_INSTANCE_HOSTNAME=dsb-service"
- "DTH_EUREKA_SERVER_PORT=8761"
ports:
- 8899:8899
volumes:
- arender-tmp:/arender/tmp

document-converter:
image: artifactory.arondor.cloud:5001/arender-document-converter:${VERSION}
container_name: dcv-service
environment:
- "DCV_EUREKA_INSTANCE_METADATA.MAP_HOST.NAME=dcv-service"
- "DCV_APP_EUREKA_HOSTNAME=dsb-service"
- "DCV_APP_EUREKA_PORT=8761"
ports:
- 19999:19999
volumes:
- arender-tmp:/arender/tmp

# Shared temporary folder
volumes:
arender-tmp:
.env
VERSION=2023.18.0

Run:

docker compose up -d

The full stack is started automatically, each component in its own container.


8. Troubleshooting

Image not found

  • Ensure registry login
  • Check repository name and version

Container stops immediately

Check logs:

docker logs <container>

Ports already in use

Ensure ports 8761 / 8899 / 9091 / 19999 are free.


If you need assistance, please contact ARender Support.