The Sign’Stash Proxy allows 3 integration modes, some of which requiring specific configuration parameters.
The different modes are presented in order of capabilities which are cumulative, meaning that when using a particular mode, e.g. Hot-Folder Async Mode, it is still possible to use the previous ones, e.g. API Sync and Async Modes.
All specific configuration parameters will be presented in a dedicated section.
General Architecture
For global reference the Sign’Stash Proxy components are in gray background, the Sign’Stash SaaS is on a green background, and the blue background pertains to the client service components.
Execution Requirements
Docker engine 19+
For more inital setup installation please refer to Docker installation instructions.
Common Parameters
Regardless of the format chosen, the parameters described below are mandatory and transversal to all modes, and must be associated with the docker run command according to your requirements.
Parameter | Description |
|---|---|
UID | Id suffix of the volume to attach to the container (e.g. _ssproxy). |
PORT | Exposed port for public access (e.g. 8085). |
MEMORY | Maximum memory that the docker can use (e.g. 4g). |
IMAGE_ID | Id/Unique name of the docker image to execute (e.g. 07da08a1e977). |
SAAS_DOMAIN | Domain of the Sign'Stash SaaS enviroment to invoke:
|
PROXY_HOSTNAME (optional) | Customer infrastructure proxy hostname. |
PROXY_PORT (optional) | Customer infrastructure proxy port. |
Base instructions for Sign’Stash Proxy docker image execution
Load the provided Sign’Stash Proxy image into your docker environment (official documentation in Docker Documentation)
-- Import to docker from a local archive docker load --input /path/to/exampleimage.tar
Please refer to the documentation for the desired Proxy mode in order to check how to start the docker image:
If you local environment uses a network proxy to reach external services, then the following parameters need to be added to the docker run command:
--einvoice-integration-client.rest.provider.proxy.hostname=[PROXY_HOSTNAME] --einvoice-integration-client.rest.provider.proxy.port=[PROXY_PORT]
Synchronous mode example using a network proxy:
docker run -d --mount source=vol[UID],target=/tmp --mount type=bind,source=[PATH_TO_WORK_FOLDER],target=/home -p [PORT]:8080 --memory=[MEMORY] [IMAGE_ID] --server.host.port=[HOST]:[PORT] --einvoice-integration-client.service.domain=[SAAS_DOMAIN] --hot.folder.enabled=[HT_ENABLED] --einvoice-integration-client.rest.provider.proxy.hostname=[PROXY_HOSTNAME] --einvoice-integration-client.rest.provider.proxy.port=[PROXY_PORT]
Swagger Documentation
In any of the described modes, after starting the service correctly, it should be possible to access the swagger documentation through the URL:
http://[HOST]:[PORT]/signstash/einvoice-integration-client-ws/swagger-ui/index.html
(For proxy versions older than v1.6+b88 the URL is http://[HOST]:[PORT]/signstash/einvoice-integration-client-ws/swagger-ui.html)