Deploy

TL;DR¶

Run a Docker volume that references your configuration file
Register Signing Agent via Partner API

Important

Access the Docker image for the Signing Agent from the Signing Agent public repository.

Prerequisites¶

Docker installed
Qredo account with supporting API keys enabled
- API key
- Base64 PrivateKey
Signing Agent config.yaml file set up

Tip

It is important to understand the configuration options for Signing Agent.

Run Docker image of Signing Agent¶

Create a local folder for storing the configuration data and the agent database.

For this example, we create the folder volume in the user's directory from the terminal:
```
    mkdir home/user/volume
```
Create a Docker volume which references this local folder.

The volume must be created first so that the Docker image can reference the local folder (Learn more about Docker volumes). From the terminal, the command is:
```
docker volume create --name volume_folder --opt type=none --opt device=/home/user/volume --opt o=bind
```
Access the docker image for the Signing Agent here.
Copy the configuration file, config.yaml, from the image folder into the local folder volume.
Import the image into Docker. From the terminal, the command is:

docker load < /path/to/docker/image.tar
Run the Docker image. From the terminal, the command is:

docker run -p 8007:8007 -v volume_folder:/volume signing-agent:dev

Register your Signing Agent¶

The Docker volume provides a self-serve restAPI service that registers your Signing Agent with Partner API. Call /register, substituting your URL for the Signing Agent service.

Important

Retain your agentID, you will need this later.

Example request:¶

curl -X 'POST' \
  'https://agent.example.org/api/v1/register' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "Test Agent",
        "APIKey": "Partner APIKey from the WebApp",
        "base64PrivateKey": "token from the clipboard"
}'

Example response:¶

{
    "agentID":"CBApocs97bS7SgE21Ht5xRHFWRbcrH9AMZHgsoUd2gpp",
    "feedURL":"ws://localhost:8007/api/v1/client/CBAp...2gpp/feed"
}

Information

Access the endpoint specification.

Last update: 2022-12-17