For on-premise self-hosted Microblink API server OCR application
1M+
This API enables scanning of over 500 international identity documents, including driving licenses, national identity cards, passports, and others. For more information please see documentation.
Licensee and License key are required for running this Docker image locally!
To get your licensee and license key, please create account in the Microblink Developer Hub https://developer.microblink.com/license and after that please contact Sales Team at [email protected], someone will ASAP generate for you DEMO or PRODUCTION licensee/license key combination (packed in the custom docker-compose.yml) with which you will be able to start this Docker Image and try it locally with one command.
Docker compose is a recommended way to run this Docker image. Download docker-compose.yml from here and update your license details. Run it with command docker-compose up -d and Microblink API will then be available at the endpoint http://localhost:8080.
Run this command and Microblink API will be available at the endpoint http://localhost:8080.
docker run -p 8080:8080 -e "LICENSEE=xxxx" -e "LICENSE_KEY=xxxx" -v /etc/machine-id:/etc/machine-id -v /var/lib/dbus/machine-id:/var/lib/dbus/machine-id microblink/api
Well documented environment variables are available in the documention.
Most of the environment variables are recommended to stay unchanged except for the required variables.
LICENSEE - Your licensee. REQUIRED.LICENSE_KEY - Your license key. REQUIRED.PORT - Exposed port for API. Default is 8080.GRACEFUL_SHUTDOWN_TIMEOUT - Graceful shutdown timeout in duration format. Default is 'PT15S'.WRAPPER_PATH - Path for wrapper to override autoconfiguration.WORKER_TIMEOUT_MS - Max time to wait for recognition process. - Default is 20000 .AVAILABLE_WORKER_TIMEOUT_MS - Max time to wait for available recognition worker. Default is 10000.WORKERS_POOL_SIZE - Number of recognition workers. Default is 2.ENABLE_METRICS - Enable metrics endpoint. Default is false.ENABLE_HEALTH_ENDPOINTS - Enable health, liveness and readiness endpoints. Default is true.ENABLE_SECURITY - Enable basic security. Default is false.BASIC_AUTH_USERNAME - Username for Basic authentication header.BASIC_AUTH_PASSWORD - Password for Basic authentication header.IMAGE_ALLOW_INVALID_CERTIFICATE - Whether to allow download of images from Url with invalid certificate. IDefault is trueIMAGE_DOWNLOAD_TIMEOUT - Max time for image download from provided image Url. Default is 10000.IMAGE_MAX_SIZE_KB - Max image size in kilobytes. Empty value means unlimited. Image size is unlimited by default.IMAGE_URL_PROTOCOLS_ALLOWED - Allowed protocols for image download. Default is 'http,https'.IMAGE_URL_HOSTS_ALLOWED - Allowed hosts for image download. Empty value means all hosts are allowed.IMAGE_URL_PORTS_ALLOWED - Allowed ports for image download. Empty value means all ports are allowed.IMAGE_URL_DIRECTORIES_ALLOWED - Allowed directories for image download. Empty value means all directories are allowed. Works only if file protocol is specified.ENABLE_REQUEST_SUMMARY - Whether to enable request summary in log. Default is true.LOG_ENABLE_CUSTOMIZATION - Whether to allow logger customizations. Default is false.LOG_ENABLE_CONSOLE_APPENDER - Whether to enable console appender. Default is true.LOG_ENABLE_FILE_APPENDER - Whether to enable file appender. Log files are placed inside docker container in /logs folder. Default is false.LOG_PATTERN - Custom pattern for logback. You can use %X{traceId} and %X{executionId} from MDC to track request.LOGGER_MAP - Logger key-values pairs. For more detailed logging provide "com.microblink:DEBUG"ALLOW_CORS - Whether to enable CORS. Default is true.ALLOWED_METHODS - CORS allowed methods. Default is 'GET,POST,OPTIONS'.ALLOWED_ORIGINS - CORS allowed origins. Empty value means all origins are allowed.PROXY_HOST - The host name of the proxy server.PROXY_PORT - The port number of the proxy server.TRUST_STORE - Trust store path.TRUST_STORE_PASSWORD - Trust store password. Needed only if a trust store is password protected.SSL_ENABLED - Whether SSL is enabled.SSL_KEY_STORE_PATH - SSL key store path.SSL_KEY_STORE_PASSWORD - SSL key store password.SSL_KEY_STORE_TYPE - Type of keystore.SSL_KEY_STORE_PROVIDER - Name of the key store provider.SSL_KEY_PASSWORD - SSL key password.SSL_KEY_ALIAS - SSL key alias.JAVA_OPTS - Runtime Java options for GraalVM native image..HEALTH_CUSTOM_URL - Custom health endpoint.This are the links to the documentation and demo pages for this backend application and client's SDKs.
Microblink API documentation
Zendesk knowledge base
Microblink website
BlinkID ImageCapture In-browser SDK
List of open source software dependencies used in application
If you did not find details about integration and examples for your specific use-case in the listed links above in the Documentation section. Please provide more details to us at [email protected] and we will try to find a best solution for your issue ASAP.
Docker Compose is recommended a way to run this Docker image. For more details, please check the recommended template at GitHub.
Well documented environment variables are available in the publicly Dockerfile from which this image is built source are available at GitHub.
Most of the environment variables are recommended to stay unchanged except for the required variables. They are documented in the Dockerfile separated by the categories
REQUIRED - without their setup application is not able to runOPTIONAL - variables for specific application behaviourADVANCED - these are optional variables but it is not recommended to change them, only if you have some specific use-case, but for most scenarios default values are set to achieve application's best fit in general environmentAll examples (HTTP requests) are available in the Postman collection, please download it here.
Release notes are available here.
Content type
Image
Digest
sha256:9a6cae76c…
Size
94.4 MB
Last updated
5 months ago
docker pull microblink/api