Quick Setup

Pre-Requisites

**Note: All service providers must meet these prerequisites to integrate this feature

System Requirements:

OS and Docker

• Linux OS : RHEL 7.9

• Docker version: 20.10.5

Docker compose Yaml version

• Optional

Minimum Hardware configuration need be defined in Docker compose:

• CPU: 0.5 and RAM -Xms1024m -Xmx2048m

Mandatory Environment variable related to client_id, apiKey, redireactUrl and quarkus_profile

• tx.clientId=***************

• tx.apiKey=****************

• tx_tokenRedirectUrlV2=http://{HOST}:{PORT}/v2/signature/token

• tx_signIndenRedirectUrlV2=http://{HOST}:{PORT}/v2/signature/sign-identity

• QUARKUS_PROFILE=****(STG,PROD)

Mandatory Environment Endpoint (DESC and ICP Specific)

Production	Staging	Whitelisting Required	Description
https://id.uaepass.ae	https://stg-id.uaepass.ae	Yes	Required from SP end
https://apis.uaepass.ae	https://stg-apis.uaepass.ae	Yes	Required from SP end
https://ca-services.desc.gov.ae/adss/tsa	https://app.stg-ca.desc.gov.ae/adss/tsa	Yes	Required from SP , DESC end
http://ca-service.ocsp.ica.gov.ae	http://ca-service-stg.ocsp.ica.gov.ae	Yes	Required from SP end
http://repository.ica.gov.ae/cert/ICAQualifiedCAG4E3.crt	http://repository-stg.ica.gov.ae/cert/ICAQualifiedCAR4S3.crt	Yes	Required from SP end

Business requirements:

• A user who wants to use this service should have Qualified-level signature. Otherwise, the user will not be able to reach the step of signing a document.

• Document count for one batch operation should be no more than 10.

• Maximum size for a single document should be no more than 10 MB.

• Maximum validity of a signed document is limited to 3 years.

Running service instructions

Follow the below instruction to run the esign docker image.

1. Download and install Docker Window.

2. Verify the docker running using below steps.

   • Open command/terminal application based on windows, Linux, macOS based system.

   • Run this command to verify if docker installed and started.

   docker version

Below is the screenshot for reference:

1. Download the provided zip folder and unzip it. Below is the screenshot for reference:

Sample image and .yaml file

For Staging and Production environments, Service provider needs to request for Zip file from UAEPASS Onboarding team. The version of the image will be subjected to change.

sample docker-compose.yaml file

1. Update the docker-compose.yaml file with required properties and save the file. The .yaml file will be shared by UAE PASS team.

2. Update image parameter in the docker compose yaml file. Image will be shared by UAE PASS operations team in case of any changes.

image: "ddtr.dubai.gov.ae/uaepass/esign:1.1.120"

1. Load the esign docker image.

2. Open command/terminal window and navigate to the esign image downloaded location. Run below command to load esign docker image. Below is the screenshot for reference:

docker load < [esign_image].tar.gz
Example:docker load < esign_1.1.40.tar.gz

Note: Docker compose file and esign image should be in the same folder/location on the local machine.

1. Navigate to the location of esign and docker compose file and run the below command in step 9.

2. Use below command to run docker image with attached log mode. Below is the screenshot for reference:

docker-compose [DOCKER_COMPOSE_FILE] up 
Example: docker-compose up

1. Use below command to run docker image with detached log mode.

docker-compose -d  < [DOCKER_COMPOSE_FILE] up
Example: docker-compose up -d

1. Run below command to stop docker esign service.

docker-compose down