Skip to main content

Customizing pdf2Data Editor application

This documentation describes all the environment variables with which you can customize your pdf2Data UI instance. In order to perform customizations, you should first create an environment configuration file either manually or using the helper script, and then make the necessary changes to the environment variables before running the deploy command.

Memory specific​

PDF2DATA_EDITOR_CONTAINER_MEMORY_LIMIT​

Default value: 819M

Memory limit for the editor container. Format: <number>[<unit>]. The number is a positive integer. The unit can be one of b, k, m, or g. Minimum is 6m

PDF2DATA_EDITOR_JVM_MEMORY_LIMIT_MB​

Default value: 1024

Memory limit for the editor's Java heap. Should be less than the limit for the editor's container memory limit

PDF2DATA_MANAGER_BACKEND_CONTAINER_MEMORY_LIMIT​

Default value: 819M

Memory limit for the manager BE container. Format: <number>[<unit>]. The number is a positive integer. The unit can be one of b, k, m, or g. Minimum is 6m

PDF2DATA_MANAGER_BACKEND_JVM_MEMORY_LIMIT_MB​

Default value: 1024

Memory limit for the manager's BE Java heap. Should be less than the limit for the manager's BE container memory limit

PDF2DATA_MANAGER_DATABASE_CONTAINER_MEMORY_LIMIT​

Default value: 205M

Memory limit for the manager DB container. Format: <number>[<unit>]. The number is a positive integer. The unit can be one of b, k, m, or g. Minimum is 6m

PDF2DATA_MANAGER_FRONTEND_CONTAINER_MEMORY_LIMIT​

Default value: 205M

Memory limit for the manager FE container. Format: <number>[<unit>]. The number is a positive integer. The unit can be one of b, k, m, or g. Minimum is 6m

Common variables​

These variables will be used in both minimal (PDF2DATA_EDITOR_MODE=STANDALONE) and full application (PDF2DATA_EDITOR_MODE=MANAGER) deployment modes

PDF2DATA_EDITOR_MODE​

Default value: STANDALONE

Deployment mode. MANAGER is for the full application (Editor + Manager, recommended), STANDALONE is for minimal standalone Editor setup

PDF2DATA_EDITOR_TEMPLATE_REPOSITORY_MANAGER_HOST​

Default value: http://pdf2data-manager-backend:8080/api

The URL to connect to the pdf2Data Manager Backend API

PDF2DATA_EDITOR_WORK_DIRECTORY_CLEANUP_POLICY_MAX_AGE​

Default value: 30d

The max duration for which editor's files on disk live (if not crossing another threshold)

PDF2DATA_EDITOR_WORK_DIRECTORY_CLEANUP_POLICY_MAX_TOTAL_SIZE​

Default value: 3GB

The max total size of the editor's disk space used

PDF2DATA_EDITOR_WORK_DIRECTORY_CLEANUP_POLICY_INTERVAL​

Default value: 43200

The interval between cleanup jobs runs in seconds, default is equivalent to 12h.

PDF2DATA_EDITOR_MAX_FILE_SIZE​

Default value: 20MB

Maximum PDF file size that can be uploaded on the editor side

PDF2DATA_EDITOR_FILE_SIZE_THRESHOLD​

Default value: 20MB

PDF file size threshold after which the file will be written onto disk rather than processed in memory only

PDF2DATA_EDITOR_TEMPLATE_PROCESSING_TIMEOUT_FIT​

Default value: 40s

Sets the timeout duration for template processing for fitting. If the processing exceeds this duration, it will be terminated

PDF2DATA_EDITOR_TEMPLATE_PROCESSING_TIMEOUT_RECOGNIZE​

Default value: 45s

Sets the timeout duration for template processing for recognizing. If the processing exceeds this duration, it will be terminated

PDF2DATA_EDITOR_WEB_VIEWER_API_TOKEN​

Default value: no license.

Webviewer license key value.

PDF_2_DATA_EDITOR_DOCUMENT_PREPROCESSORS_THREADS_LIMIT​

Default value: 1

Sets the maximum number of threads for document preprocessors which can be run in parallel.

Specific for full application​

The following variables can be used to configure pdf2Data Editor in full deployment mode, so make sense only if PDF2DATA_EDITOR_MODE=MANAGER.

PDF2DATA_MANAGER_DEFAULT_ADMIN_EMAIL​

Default value: admin@email.com

Email for the initial "Global admin" user

PDF2DATA_MANAGER_DEFAULT_ADMIN_FIRSTNAME​

Default value: Global

The default admin first name

PDF2DATA_MANAGER_DEFAULT_ADMIN_LASTNAME​

Default value: Admin

The default admin last name

PDF2DATA_MANAGER_DEFAULT_ADMIN_PASSWORD​

Default value:

The default password of the initial Global Admin <admin@email.com> user

PDF2DATA_MANAGER_DEFAULT_ADMIN_FORCE_UPDATE​

Default value: false

A boolean. If the flag false and there is no user in the system it creates an admin, if there are users it doesn't create one. If the flag is true it creates, if there is such a user it gives him rights and updates first name and last name.

Note: This flag used for access the system if you have lost your password

PDF2DATA_MANAGER_DEFAULT_TOKEN_PRIVATE_KEY​

Default value: no exact default value, will be generated by deployment script

JWT private key

PDF2DATA_MANAGER_DEFAULT_TOKEN_ISSUER​

Default value: pdf2data-template-manager

The default token issuer

PDF2DATA_MANAGER_RESET_PASSWORD_TOKEN_TIME_TO_LIVE​

Default value: 24h

Reset token time to live

PDF2DATA_MANAGER_RESET_PASSWORD_TOKEN_PRIVATE​

Default value: obtained from PDF2DATA_MANAGER_DEFAULT_TOKEN_PRIVATE_KEY

The private key for reset password token

PDF2DATA_MANAGER_RESET_PASSWORD_TOKEN_ISSUER​

Default value: obtained from PDF2DATA_MANAGER_DEFAULT_TOKEN_ISSUER

Reset password token issuer

PDF2DATA_MANAGER_ACCESS_TOKEN_TIME_TO_LIVE​

Default value: 30m

Access token time to live

PDF2DATA_MANAGER_ACCESS_TOKEN_PRIVATE​

Default value: obtained from PDF2DATA_MANAGER_DEFAULT_TOKEN_PRIVATE_KEY

The private key for access token

PDF2DATA_MANAGER_ACCESS_TOKEN_ISSUER​

Default value: obtained from PDF2DATA_MANAGER_DEFAULT_TOKEN_ISSUER

Access token issuer

PDF2DATA_MANAGER_REFRESH_TOKEN_TIME_TO_LIVE​

Default value: 14d

Refresh token time to live

PDF2DATA_MANAGER_REFRESH_TOKEN_PRIVATE​

Default value: obtained from PDF2DATA_MANAGER_DEFAULT_TOKEN_PRIVATE_KEY

The private key for refresh token

PDF2DATA_MANAGER_REFRESH_TOKEN_ISSUER​

Default value: obtained from PDF2DATA_MANAGER_DEFAULT_TOKEN_ISSUER

Refresh token issuer

PDF2DATA_MANAGER_MAX_FILE_SIZE​

Default value: 20MB

The maximum PDF file size that can be uploaded on manager side

PDF2DATA_MANAGER_MAX_REQUEST_SIZE​

Default value: 30MB

The maximum multipart request size

PDF2DATA_MANAGER_MULTIPLE_WORKSPACES​

Default value: false

The multiple workspaces feature toggle

Default value: true

A boolean value that defines whether the refresh token-related cookie should be secured (i.e. send only via https). By default, this value is set to true, i.e. secured is enabled. If you don't have https setup (e.g. if you're testing locally or in internal network), then set its value to false

PDF2DATA_EDITOR_URL​

Default value: pdf2data-editor:8080

The base URL to the pdf2Data Editor container

PDF2DATA_MANAGER_BACKEND_URL​

Default value: pdf2data-manager-backend:8080

The base URL to the pdf2Data Manager Backend container

PDF2DATA_MANAGER_DB_URL​

Default value: pdf2data-manager-db:5432

The base URL to the pdf2Data Manager Database container

PDF2DATA_MANAGER_DB_NAME​

Default value: postgres

The name of Manager DB to connect. Must be the same value as POSTGRES_DB

PDF2DATA_MANAGER_DB_SCHEMA​

Default value: manager

The name of the DB schema to serve Manager

PDF2DATA_MANAGER_DB_USERNAME​

Default value: postgres

The username to connect to DB. Must be the same value as POSTGRES_USER

PDF2DATA_MANAGER_DB_PASSWORD​

Default value: postgres

The password to connect to DB. Must be the same value as POSTGRES_PASSWORD

PDF2DATA_MANAGER_JPA_GENERATE_STATISTICS​

Default value: false

A boolean, JPA generate statistics

PDF2DATA_MANAGER_JPA_SHOW_SQL​

Default value: false

A boolean, JPA show SQL

POSTGRES_DB​

Default value: postgres

The Postgres database name to serve Manager

POSTGRES_USER​

Default value: postgres

The Postgres database username

POSTGRES_PASSWORD​

Default value: postgres

The password to the Postgres database