microblink/microblink-proxy repository overview

⁠Introduction

The Microblink Proxy feature offers an alternative method for collecting usage statistics from client devices and license status check, without the need for direct communication with Microblink's services. This approach is designed to suit clients who prefer or require that data be routed through a central point within their controlled environment (such as a DMZ) before being forwarded to Microblink. In order to use this feature, you need to have a valid Microblink license that includes Microblink Proxy usage rights.

⁠Supported tags

• 1.0.0
• 1.1.0, latest

⁠Feature Overview

To utilize the Microblink Proxy for usage data collection and license status check, your Microblink SDK must include the necessary licensing rights. This solution employs HTTPS for secure communication between the client device and the Microblink Proxy, ensuring that HTTP without SSL/TLS is not used.

⁠Setup Instructions

⁠Using Docker compose

For ease of deployment, Docker Compose is the recommended method to run this Docker image: Download docker-compose.yml⁠ Run docker-compose up -d The Png Proxy service will be accessible at the endpoint http://localhost:8080⁠

⁠Using Docker directly

Run the following Docker command to start the Microblink Proxy service:

 docker run -p 8080:8080 microblink/microblink-proxy  

Note: The above command starts the service accessible via http://localhost:8080⁠ for local development. For production and test environments, ensure HTTPS is configured and enabled.

⁠Verifying Successful Setup

To confirm that the Microblink Proxy service is running correctly on your local machine, run the following command:

 curl http://localhost:8080/info 

If the setup is successful, you should see a response similar to:

{"appVersion":"1.1.0","appName":"microblink-proxy"}

⁠Recommended Runtime Options

For optimal performance, (e.g., 50 requests/second), we recommend the following settings:

CPU: 1 core Memory: 2 GB

⁠Configuration

Customize your setup with these environment variables:

• 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 - SSL key store type.
• SSL_KEY_STORE_PROVIDER - SSL key store provider name
• SSL_KEY_PASSWORD - SSL key password.
• SSL_KEY_ALIAS - SSL key alias.
• 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.
• LOCALHOST_PASS_THROUGH - Sets whether localhost pass-through is enabled. Default value false. Setting this to true will allow requests to be made to localhost from any origin.

⁠Security Best Practices

Always enable SSL in all environments to ensure data safety. Regularly update your Docker images to incorporate the latest security patches. Use secure passwords and manage SSL certificates carefully to prevent unauthorized access. The client is responsible for implementing measures to ensure the system's safety and its ability to scale, crucial for consistent service performance and reliability.

⁠Resources

For further information and support, refer to the following resources:

Microblink Android documentation

• https://github.com/BlinkID/blinkid-android⁠

Microblink iOS documentation

• https://github.com/BlinkID/blinkid-ios⁠

Microblink website

• https://developer.microblink.com⁠
• https://developer.microblink.com/doc/blink-id⁠
• https://developer.microblink.com/doc/blink-card⁠

⁠Troubleshooting and Common Errors

SSL Setup Issues: Ensure your SSL certificates are valid and properly configured. Docker-related errors: Verify that Docker is correctly installed and that you have sufficient permissions to execute Docker commands. Network Configuration for Communication: It's critical to configure your network to allow communication with https://ping.microblink.com⁠ and https://baltazar.microblink.com⁠. Ensure your firewall and network settings permit outbound HTTPS requests to this URL.

⁠Support

For assistance or questions regarding specific integration scenarios not covered in this documentation, please contact our support team at [email protected]⁠ for a prompt response.

⁠Release notes

⁠Version 1.1.0

• Added support for CORS configuration

⁠Version 1.0.0

• Initial public version