alfresco-transform-core/docs/external-engine-configuration.md
tiagosalvado10 b9bcc3c9d2
[MNT-23960] Added new options (pdfFont, pdfFontSize) to textToPdf transformer (#885)
* [MNT-23960] Added options (pdfFont, pdfFontSize) and NotoSans fonts to textToPdf transformer

* [MNT-23960] Added 'MISC_PDFBOX_DEFAULT_FONT' and 'transform.core.misc.pdfbox.defaultFont' configuration to core-aio and misc T-Engines

* [MNT-23960] Added NotoSans fonts to core-aio and misc T-Engine images

* [MNT-23960] Improved logging: added messages, using placeholders

* [MNT-23960] Added DEFAULT_FONT constant (NotoSans-Regular)

* [MNT-23960] Splitted getFont(PDDocument, String) code into 3 methods. Added Javadoc.

* [MNT-23960] Return TransformCheckResult on transformTextAndCheck methods. Added assertion to testUTF8WithBOM test.
2024-02-06 16:26:25 +00:00

5.9 KiB

T-engine properties can be configured externally

In order to configure an external property it needs to be set as ENV property.

The following externalized T-engines properties are available:

Tika

Property Description Default value
SERVER_PORT T-Engine Port. 8090
HOSTNAME T-Engine Name. t-engine
ACTIVEMQ_URL ActiveMQ URL. nio://localhost:61616
ACTIVEMQ_USER ActiveMQ User. admin
ACTIVEMQ_PASSWORD ActiveMQ Password. admin
FILE_STORE_URL T-Engine Port. http://localhost:8099/alfresco/api/-default-/private/sfs/versions/1/file
PDFBOX_NOTEXTRACTBOOKMARKS_DEFAULT The default behaviour for notExtractBookmarksText when this request param is omitted from a request. false
TRANSFORM_ENGINE_REQUEST_QUEUE T-Engine queue used for receiving async requests. org.alfresco.transform.engine.tika.acs

Pdf-renderer

Property Description Default value
SERVER_PORT T-Engine Port 8090
HOSTNAME T-Engine Name. t-engine
ACTIVEMQ_URL ActiveMQ URL. nio://localhost:61616
ACTIVEMQ_USER ActiveMQ User. admin
ACTIVEMQ_PASSWORD ActiveMQ Password. admin
FILE_STORE_URL T-Engine Port. http://localhost:8099/alfresco/api/-default-/private/sfs/versions/1/file
TRANSFORM_ENGINE_REQUEST_QUEUE T-Engine queue used for async requests. org.alfresco.transform.engine.alfresco-pdf-renderer.acs
PDFRENDERER_EXE Path to Pdf-renderer EXE. /usr/bin/alfresco-pdf-renderer

Misc

Property Description Default value
SERVER_PORT T-Engine Port 8090
HOSTNAME T-Engine Name. t-engine
ACTIVEMQ_URL ActiveMQ URL. nio://localhost:61616
ACTIVEMQ_USER ActiveMQ User. admin
ACTIVEMQ_PASSWORD ActiveMQ Password. admin
FILE_STORE_URL T-Engine Port. http://localhost:8099/alfresco/api/-default-/private/sfs/versions/1/file
TRANSFORM_ENGINE_REQUEST_QUEUE T-Engine queue used for async requests. org.alfresco.transform.engine.misc.acs
MISC_PDFBOX_DEFAULT_FONT Default font used by PdfBox NotoSans-Regular

Libreoffice

Property Description Default value
SERVER_PORT T-Engine Port 8090
HOSTNAME T-Engine Name. t-engine
ACTIVEMQ_URL ActiveMQ URL. nio://localhost:61616
ACTIVEMQ_USER ActiveMQ User. admin
ACTIVEMQ_PASSWORD ActiveMQ Password. admin
FILE_STORE_URL T-Engine Port. http://localhost:8099/alfresco/api/-default-/private/sfs/versions/1/file
TRANSFORM_ENGINE_REQUEST_QUEUE T-Engine queue used for async requests. org.alfresco.transform.engine.libreoffice.acs
LIBREOFFICE_HOME Path to LibreOffice_Home. /opt/libreoffice7.2
LIBREOFFICE_MAX_TASKS_PER_PROCESS Number of maximum tasks per process. 200
LIBREOFFICE_TIMEOUT Timeout value for LibreOffice execution timeout, queue timeout and connection timeout. 1200000
LIBREOFFICE_PORT_NUMBERS LibreOffice port. 8100
LIBREOFFICE_TEMPLATE_PROFILE_DIR Path to user profile.
LIBREOFFICE_IS_ENABLED Enables Libreoffice executioner. true

Imagemagick

Property Description Default value
SERVER_PORT T-Engine Port 8090
HOSTNAME T-Engine Name. t-engine
ACTIVEMQ_URL ActiveMQ URL. nio://localhost:61616
ACTIVEMQ_USER ActiveMQ User. admin
ACTIVEMQ_PASSWORD ActiveMQ Password. admin
FILE_STORE_URL T-Engine Port. http://localhost:8099/alfresco/api/-default-/private/sfs/versions/1/file
TRANSFORM_ENGINE_REQUEST_QUEUE T-Engine queue used for async requests. org.alfresco.transform.engine.imagemagick.acs
IMAGEMAGICK_ROOT Path to Imagemagick Root. /usr/lib64/ImageMagick-7.0.10
IMAGEMAGICK_DYN Path to Imagemagick DYLD. /usr/lib64/ImageMagick-7.0.10/lib
IMAGEMAGICK_EXE Path to Imagemagick EXE. /usr/bin/convert
IMAGEMAGICK_CODERS Path to Imagemagick custom coders.
IMAGEMAGICK_CONFIG Path to Imagemagick custom config.

Core-aio

Property Description Default value
SERVER_PORT T-Engine Port 8090
HOSTNAME T-Engine Name. t-engine
ACTIVEMQ_URL ActiveMQ URL. nio://localhost:61616
ACTIVEMQ_USER ActiveMQ User. admin
ACTIVEMQ_PASSWORD ActiveMQ Password. admin
FILE_STORE_URL T-Engine Port. http://localhost:8099/alfresco/api/-default-/private/sfs/versions/1/file
PDFBOX_NOTEXTRACTBOOKMARKS_DEFAULT The default behaviour for notExtractBookmarksText when this request param is omitted from a request. false
TRANSFORM_ENGINE_REQUEST_QUEUE T-Engine queue used for async requests. org.alfresco.transform.engine.aio.acs
PDFRENDERER_EXE Path to Pdf-renderer EXE. /usr/bin/alfresco-pdf-renderer
TRANSFORM_ENGINE_REQUEST_QUEUE T-Engine queue used for async requests. org.alfresco.transform.engine.libreoffice.acs
LIBREOFFICE_HOME Path to LibreOffice_Home. /opt/libreoffice7.2
LIBREOFFICE_MAX_TASKS_PER_PROCESS Number of maximum tasks per process. 200
LIBREOFFICE_TIMEOUT Timeout value for LibreOffice execution timeout, queue timeout and connection timeout. 1200000
LIBREOFFICE_PORT_NUMBERS LibreOffice port. 8100
LIBREOFFICE_TEMPLATE_PROFILE_DIR Path to user profile.
LIBREOFFICE_IS_ENABLED Enables Libreoffice executioner. true
IMAGEMAGICK_ROOT Path to Imagemagick Root. /usr/lib64/ImageMagick-7.0.10
IMAGEMAGICK_DYN Path to Imagemagick DYLD. /usr/lib64/ImageMagick-7.0.10/lib
IMAGEMAGICK_EXE Path to Imagemagick EXE. /usr/bin/convert
IMAGEMAGICK_CODERS Path to Imagemagick custom coders.
IMAGEMAGICK_CONFIG Path to Imagemagick custom config.
MISC_PDFBOX_DEFAULT_FONT Default font used by PdfBox NotoSans-Regular