# Quick Setup

## Pre-Requisites

{% hint style="info" %} <mark style="color:green;">**\*\*Note: All service providers must meet these prerequisites to integrate this feature**</mark>
{% endhint %}

**System Requirements:**

&#x20;     **OS and Docker**     &#x20;

* Linux OS : RHEL 7.9
* Docker version: 20.10.5

&#x20;     **Docker compose Yaml version**

* Optional    &#x20;

#### &#x20;     **Minimum Hardware configuration need be defined in Docker compose:**

* CPU: 0.5  &#x20;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)**

<table><thead><tr><th width="248.66668701171875" valign="top">Production</th><th width="263.3333740234375" valign="top">Staging</th><th width="170.3333740234375" valign="top">Whitelisting Required</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><a href="https://id.uaepass.ae">https://id.uaepass.ae</a></td><td valign="top"> <a href="https://stg-id.uaepass.ae">https://stg-id.uaepass.ae</a></td><td valign="top">Yes</td><td valign="top">Required from SP end</td></tr><tr><td valign="top"><a href="https://apis.uaepass.ae">https://apis.uaepass.ae</a></td><td valign="top"><a href="https://stg-apis.uaepass.ae">https://stg-apis.uaepass.ae</a></td><td valign="top">Yes</td><td valign="top">Required from SP end</td></tr><tr><td valign="top"><a href="https://ca-services.desc.gov.ae/adss/tsa">https://ca-services.desc.gov.ae/adss/tsa</a></td><td valign="top"><a href="https://app.stg-ca.desc.gov.ae/adss/tsa">https://app.stg-ca.desc.gov.ae/adss/tsa</a></td><td valign="top">Yes</td><td valign="top">Required from SP , DESC end</td></tr><tr><td valign="top"><a href="http://ca-service.ocsp.ica.gov.ae">http://ca-service.ocsp.ica.gov.ae</a></td><td valign="top"><a href="http://ca-service-stg.ocsp.ica.gov.ae">http://ca-service-stg.ocsp.ica.gov.ae</a></td><td valign="top">Yes</td><td valign="top">Required from SP end</td></tr><tr><td valign="top"><a href="http://repository.ica.gov.ae/cert/ICAQualifiedCAG4E3.crt">http://repository.ica.gov.ae/cert/ICAQualifiedCAG4E3.crt</a></td><td valign="top"><a href="http://repository-stg.ica.gov.ae/cert/ICAQualifiedCAR4S3.crt">http://repository-stg.ica.gov.ae/cert/ICAQualifiedCAR4S3.crt</a></td><td valign="top">Yes</td><td valign="top">Required from SP end</td></tr></tbody></table>

#### &#x20;  **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.

   <pre class="language-sh" data-full-width="false"><code class="lang-sh">docker version
   </code></pre>

Below is the screenshot for reference:

<figure><img src="/files/Puy7jJDeH8A9gJSzSQM3" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/TJ84VbWcEs6IkikmMlh2" alt=""><figcaption><p><mark style="color:green;">Sample image and .yaml file</mark></p></figcaption></figure>

{% hint style="info" %} <mark style="color:green;">**For Staging and Production environments, Service provider needs to request for Zip file from UAEPASS Onboarding team**</mark><mark style="color:green;">.</mark> <mark style="color:green;"></mark><mark style="color:green;">**The version of the image will be subjected to change.**</mark>
{% endhint %}

<figure><img src="/files/UineXMoEmIVZxzo8dKRh" alt=""><figcaption><p><mark style="color:green;"><strong>sample docker-compose.yaml file</strong></mark> </p></figcaption></figure>

4. Update the docker-compose.yaml file with required properties and save the file. <mark style="color:green;">The .yaml file will be shared by UAE PASS team.</mark>
5. Update image parameter in the docker compose yaml file. Image will be shared by UAE PASS operations team in case of any changes.

&#x20;   `image: "ddtr.dubai.gov.ae/uaepass/esign:1.1.120"`

6. Load the esign docker image.
7. 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:

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

<figure><img src="/files/smrO7CAkguFzhBHgZlCR" alt=""><figcaption></figcaption></figure>

{% hint style="info" %} <mark style="color:green;">**Note: Docker compose file and esign image should be in the same folder/location on the local machine.**</mark>
{% endhint %}

8. Navigate to the location of esign and docker compose file and run the below command in step 9.
9. Use below command to run docker image with attached log mode. Below is the screenshot for reference:

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

<figure><img src="/files/uSsSjKKruZaBxZv2iibY" alt=""><figcaption></figcaption></figure>

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

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

<figure><img src="/files/ICnWEUvuTu0MpvXsRlXA" alt=""><figcaption></figcaption></figure>

11. Run below command to stop docker esign service.

```sh
docker-compose down
```

>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.uaepass.ae/feature-guides/signature-integration-guide/hash-signing/bulk-hash-signing-multiple-documents/quick-setup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
