The plugin is available as a docker image.
Dependencies
Before setting up the plugin, ensure that you have the following dependencies installed and configured:
- PostgreSQL Database: You will need a PostgreSQL database to store data related to document templates and documents.
- MongoDB Database: MongoDB is required for the HTML templates feature of the plugin.
- Kafka: Establish a connection to the Kafka instance used by the FlowX.AI engine.
- Redis: Set up a Redis instance for caching purposes.
- S3-Compatible File Storage Solution: Deploy an S3-compatible file storage solution to store document files.
Configuration
The plugin comes with pre-filled configuration properties, but you need to set up a few custom environment variables to tailor it to your specific setup. Here are the key configuration steps:
Redis server
The plugin can utilize the Redis component already deployed for the FLOWX.AI engine. Make sure it is configured properly.
Authorization configuration
Changed in v5.5.0 — The default SECURITY_TYPE has changed from oauth2 to jwt-public-key. Opaque-token introspection has been removed.
| Environment Variable | Description | Default Value |
|---|
SECURITY_TYPE | Security type | jwt-public-key |
SECURITY_OAUTH2_BASESERVERURL | Base URL of the OAuth2/OIDC server | |
Document processing configuration
| Environment Variable | Description | Default Value |
|---|
FLOWX_DEFAULTCLIENTTYPE | Default client type | PF |
FLOWX_HTML_TEMPLATES_ENABLED | Enable HTML templates feature | false |
FLOWX_HTML_TEMPLATES_PDFFONTPATHS | Paths to fonts for HTML templates | /statics/fonts/Calibri.ttf, /statics/fonts/DejaVuSans.ttf |
FLOWX_CONVERT_DPI | DPI setting for PDF to image conversion | 150 |
Set the FLOWX_HTML_TEMPLATES_PDFFONTPATHS config to select the font used for generating documents based on PDF templates.
If you want to use specific fonts in your PDF templates, override the FLOWX_HTML_TEMPLATES_PDFFONTPATHS config. By default, Calibri and DejaVuSans are available fonts.
FLOWX_CONVERT_DPI: Sets the DPI (dots per inch) for PDF to JPEG conversion. Higher values result in higher resolution images. (Default value: 150).
Database configuration
SQL database (PostgreSQL)
The Documents Plugin uses a PostgreSQL database for relational data storage.
Primary MongoDB configuration
| Environment Variable | Description | Default Value |
|---|
SPRING_DATA_MONGODB_URI | MongoDB connection URI | mongodb://flowx:password@jx-document-mongodb:27017/document |
MONGODB_USERNAME | MongoDB username | flowx |
MONGODB_PASSWORD | MongoDB password | password |
SPRING_DATA_MONGODB_UUID_REPRESENTATION | UUID representation format | standard |
SPRING_DATA_MONGODB_STORAGE | MongoDB storage type | mongodb |
Runtime MongoDB configuration
| Environment Variable | Description | Default Value |
|---|
SPRING_DATA_MONGODB_RUNTIME_ENABLED | Enable runtime MongoDB connection | true |
SPRING_DATA_MONGODB_RUNTIME_URI | Runtime MongoDB connection URI | mongodb://${MONGODB_USERNAME:flowx}:${MONGODB_PASSWORD:password}@jx-document-mongodb:27017/document |
MONGODB_USERNAME | Runtime MongoDB username | paperflow |
MONGODB_PASSWORD | Runtime MongoDB password | password |
SPRING_DATA_MONGODB_RUNTIME_AUTOINDEXCREATION | Enable automatic index creation | false |
SPRING_DATA_MONGODB_RUNTIME_UUIDREPRESENTATION | UUID representation format for runtime connection | standard |
Redis configuration
Document Plugin uses Redis for caching. Configure Redis connection using the standard Redis environment variables.
Quick reference:
| Environment Variable | Description | Example Value |
|---|
SPRING_DATA_REDIS_HOST | Redis server hostname | localhost |
SPRING_DATA_REDIS_PORT | Redis server port | 6379 |
SPRING_DATA_REDIS_PASSWORD | Redis authentication password | yourpassword |
REDIS_TTL | Cache TTL in milliseconds | 5000000 |
For complete Redis configuration including Sentinel mode, Cluster mode, and SSL/TLS setup, see the Redis Configuration guide. Multipart upload configuration
| Environment Variable | Description | Default Value |
|---|
SPRING_SERVLET_CONTEXTPATH | Servlet context path | / |
SPRING_SERVLET_MULTIPART_MAXFILESIZE | Maximum file size for uploads | 50MB |
SPRING_SERVLET_MULTIPART_MAXREQUESTSIZE | Maximum request size for multipart uploads | 50MB |
MULTIPART_MAX_ENTITY_SIZE | Maximum size for multipart entity at server level | 52428800 (50MB) |
MULTIPART_MAX_ENTITY_SIZE sets the maximum multipart upload size at the Undertow server level. This affects all file uploads handled by the document-plugin (not just email attachments). Configure this alongside the Spring multipart settings to ensure consistent upload limits.
Basic Kafka configuration
| Environment Variable | Description | Default Value |
|---|
SPRING_KAFKA_BOOTSTRAPSERVERS | Address of Kafka server(s) | localhost:9092 |
SPRING_KAFKA_SECURITY_PROTOCOL | Security protocol for Kafka | PLAINTEXT |
SPRING_KAFKA_CONSUMER_GROUPID | Consumer group ID for the service | kafka-svc-document-consumer |
KAFKA_MESSAGE_MAX_BYTES | Maximum message size in bytes | 52428800 (50MB) |
KAFKA_AUTHEXCEPTIONRETRYINTERVAL | Retry interval for auth exceptions | 10 (seconds) |
OAuth authentication (when using SASL_PLAINTEXT)
| Environment Variable | Description | Default Value |
|---|
KAFKA_OAUTH_CLIENT_ID | OAuth client ID | kafka |
KAFKA_OAUTH_CLIENT_SECRET | OAuth client secret | kafka-secret |
KAFKA_OAUTH_TOKEN_ENDPOINT_URI | OAuth token endpoint | kafka.auth.localhost |
Topic naming configuration
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_NAMING_SEPARATOR | Primary separator for topic names | . |
KAFKA_TOPIC_NAMING_SEPARATOR2 | Secondary separator for topic names | - |
KAFKA_TOPIC_NAMING_PACKAGE | Package prefix for topic names | ai.flowx. |
KAFKA_TOPIC_NAMING_ENVIRONMENT | Environment segment for topic names | |
KAFKA_TOPIC_NAMING_VERSION | Version suffix for topic names | .v1 |
Thread configuration
| Environment Variable | Description | Default Value |
|---|
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_DOCUMENTGENERATEHTMLIN | Threads for HTML document generation | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_DOCUMENTPERSISTIN | Threads for document persistence | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_DOCUMENTSPLITTIN | Threads for document splitting | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_DOCUMENTGETURLSIN | Threads for document URL retrieval | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_OCRIN | Threads for OCR processing | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_FILEDELETEIN | Threads for file deletion | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_FILEUPDATEIN | Threads for file updates | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_FILECONVERTIN | Threads for file conversion | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_FILEPERSISTIN | Threads for file persistence | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_FILECOMBINEIN | Threads for file combining | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_FILEENCRYPTIN | Threads for file encryption | 5 |
KAFKA_CONSUMER_THREADPOOLS_THREADPOOLGENERIC_THREADCOUNTPERCONTAINER_FILEDECRYPTIN | Threads for file decryption | 5 |
Document topics
Generate HTML documents
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_DOCUMENT_GENERATE_HTML_IN | Topic for incoming HTML generation requests | ai.flowx.plugin.document.trigger.generate.html.v1 |
KAFKA_TOPIC_DOCUMENT_GENERATE_HTML_OUT | Topic for HTML generation results | ai.flowx.engine.receive.plugin.document.generate.html.results.v1 |
Document persistence
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_DOCUMENT_PERSIST_IN | Topic for incoming document persistence requests | ai.flowx.plugin.document.trigger.persist.document.v1 |
KAFKA_TOPIC_DOCUMENT_PERSIST_OUT | Topic for document persistence results | ai.flowx.engine.receive.plugin.document.persist.document.results.v1 |
Document splitting
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_DOCUMENT_SPLIT_IN | Topic for incoming document splitting requests | ai.flowx.plugin.document.trigger.split.document.v1 |
KAFKA_TOPIC_DOCUMENT_SPLIT_OUT | Topic for document splitting results | ai.flowx.engine.receive.plugin.document.split.document.results.v1 |
Document URL retrieval
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_DOCUMENT_GET_URLS_IN | Topic for incoming URL retrieval requests | ai.flowx.plugin.document.retrieve.urls.v1 |
KAFKA_TOPIC_DOCUMENT_GET_URLS_OUT | Topic for URL retrieval results | ai.flowx.engine.receive.plugin.document.urls.results.v1 |
OCR processing
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_OCR_IN | Topic for incoming OCR requests | ai.flowx.plugin.document.store.ocr.v1 |
KAFKA_TOPIC_OCR_OUT | Topic for OCR processing results | ai.flowx.engine.receive.plugin.document.ocr.results.v1 |
File operation topics
File deletion
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_FILE_DELETE_IN | Topic for incoming file deletion requests | ai.flowx.plugin.document.trigger.delete.file.v1 |
KAFKA_TOPIC_FILE_DELETE_OUT | Topic for file deletion results | ai.flowx.engine.receive.plugin.document.delete.file.results.v1 |
File update
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_FILE_UPDATE_IN | Topic for incoming file update requests | ai.flowx.plugin.document.trigger.update.file.v1 |
KAFKA_TOPIC_FILE_UPDATE_OUT | Topic for file update results | ai.flowx.engine.receive.plugin.document.update.file.results.v1 |
File conversion
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_FILE_CONVERT_IN | Topic for incoming file conversion requests | ai.flowx.plugin.document.trigger.convert.file.v1 |
KAFKA_TOPIC_FILE_CONVERT_OUT | Topic for file conversion results | ai.flowx.engine.receive.plugin.document.convert.file.results.v1 |
File persistence
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_FILE_PERSIST_IN | Topic for incoming file persistence requests | ai.flowx.plugin.document.trigger.persist.file.v1 |
KAFKA_TOPIC_FILE_PERSIST_OUT | Topic for file persistence results | ai.flowx.engine.receive.plugin.document.persist.file.results.v1 |
File combination
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_FILE_COMBINE_IN | Topic for incoming file combination requests | ai.flowx.plugin.document.trigger.combine.file.v1 |
KAFKA_TOPIC_FILE_COMBINE_OUT | Topic for file combination results | ai.flowx.engine.receive.plugin.document.combine.file.results.v1 |
File encryption
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_FILE_ENCRYPT_IN | Topic for incoming file encryption requests | ai.flowx.plugin.document.trigger.encrypt.file.v1 |
KAFKA_TOPIC_FILE_ENCRYPT_OUT | Topic for file encryption results | ai.flowx.engine.receive.plugin.document.encrypt.file.results.v1 |
File decryption
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_FILE_DECRYPT_IN | Topic for incoming file decryption requests | ai.flowx.plugin.document.trigger.decrypt.file.v1 |
KAFKA_TOPIC_FILE_DECRYPT_OUT | Topic for file decryption results | ai.flowx.engine.receive.plugin.document.decrypt.file.results.v1 |
Bulk document persistence
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_DOCUMENT_PERSIST_BULK_IN | Topic for incoming bulk document persistence | ai.flowx.plugin.document.trigger.persist.document.bulk.v1 |
KAFKA_TOPIC_DOCUMENT_PERSIST_BULK_OUT | Topic for bulk document persistence results | ai.flowx.engine.receive.plugin.document.persist.document.bulk.results.v1 |
Audit
| Environment Variable | Description | Default Value |
|---|
KAFKA_TOPIC_AUDIT_OUT | Topic for sending audit logs | ai.flowx.core.trigger.save.audit.v1 |
General storage configuration
| Environment Variable | Description | Default Value |
|---|
APPLICATION_DEFAULTLOCALE | Default locale for the application | en |
APPLICATION_SUPPORTEDLOCALES | Comma-separated list of supported locales | en, ro |
APPLICATION_FILESTORAGE_TYPE | Storage type to use (s3 or fileSystem) | s3 |
APPLICATION_FILESTORAGE_DISKDIRECTORY | Directory for file storage when using filesystem | MS_SVC_DOCUMENT |
APPLICATION_FILESTORAGE_PARTITIONSTRATEGY | Strategy for file organization (NONE or PROCESS_DATE) | NONE |
APPLICATION_FILESTORAGE_DELETIONSTRATEGY | Strategy for deleting files (delete, disabled, or deleteBypassingGovernanceRetention) | delete |
APPLICATION_FILE_STORAGE_TEST_FILES_BUCKET | Custom bucket name for test files (overrides default -test-documents suffix) | -test-documents |
APPLICATION_FILESTORAGE_DELETIONSTRATEGY:
disabled: This will disable entirely the deletion of temporary files from the temporary bucket, and the responsibility to delete and clean up the bucket will move in the ownership of the admins of the implementing project.deleteBypassingGovernanceRetention: This will still delete the temporary files and further more will add in the delete request the header: x-amz-bypass-governance-retention:true , to enable deletion of governed files, in case the s3 configured user for document-plugin, will have the s3:BypassGovernanceRetention permission.
APPLICATION_FILE_STORAGE_TEST_FILES_BUCKET: This variable allows you to override the default -test-documents bucket suffix. You can configure a custom bucket name or use the same bucket as the main storage if needed. This is particularly useful when the client environment has restrictions on bucket naming conventions or doesn’t have permissions to create new buckets.
Runtime buckets configuration
| Environment Variable | Description | Default Value |
|---|
APPLICATION_FILESTORAGE_S3_RUNTIMEBUCKETS_ENABLED | Enable dedicated runtime buckets for file storage | false |
APPLICATION_FILESTORAGE_S3_RUNTIMEBUCKETS_BUCKETNAME | Name of the runtime bucket | runtime-bucket |
APPLICATION_FILESTORAGE_S3_RUNTIMEBUCKETS_PARTITIONBYDATE | Enable date-based partitioning for runtime bucket files | true |
| Environment Variable | Description | Default Value |
|---|
ZIP_EXTRACTION_ALLOWEDEXTENSIONS | Comma-separated list of allowed file extensions in ZIP uploads | pdf,xls,xlsx,doc,docx,txt,jpg,jpeg,png,gif |
S3-Compatible storage configuration
| Environment Variable | Description | Default Value |
|---|
APPLICATION_FILESTORAGE_S3_ENABLED | Enable S3-compatible storage | true |
APPLICATION_FILESTORAGE_S3_SERVERURL | URL of S3-compatible server | http://minio-service:9000 |
APPLICATION_FILESTORAGE_S3_ACCESSKEY | Access key for S3 | minio |
APPLICATION_FILESTORAGE_S3_SECRETKEY | Secret key for S3 | secret |
APPLICATION_FILESTORAGE_S3_BUCKETPREFIX | Prefix for bucket names | qdevlocal-preview-paperflow |
APPLICATION_FILESTORAGE_S3_TEMPBUCKET | Name of temporary bucket for initial file uploads | temp-bucket |
APPLICATION_FILESTORAGE_S3_ENCRYPTIONENABLED | Enable server-side encryption | false |
CAS lib configuration
| Environment Variable | Description | Default Value |
|---|
FLOWX_SPICEDB_HOST | SpiceDB server hostname | spicedb |
FLOWX_SPICEDB_PORT | SpiceDB server port | 50051 |
FLOWX_SPICEDB_TOKEN | SpiceDB authentication token | spicedb-token |
Logging configuration
| Environment Variable | Description | Default Value |
|---|
LOGGING_LEVEL_APP | Log level for application logs | DEBUG |
LOGGING_LEVEL_MONGO_DRIVER | Log level for MongoDB driver | INFO |
LOGGING_LEVEL_LIQUIBASE | Log level for Liquibase database migrations | INFO |
LOGGING_LEVEL_REDIS | Log level for Redis/Lettuce client | OFF |
LOGGING_LEVEL_ROOT | Root logging level for the application | - |
