Versions Compared

Version Old Version 13 New Version Current
Changes made by

Julio D'Angelo

Armando Carratala

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Image Modified

Table of Contents
maxLevel2
indentcircle

Service configuration


The following section explains the different parameters needed to configure a Debbie service deployment.

note

Table of Contents

title

maxLevel

Case sensitive

All Debbie configuration field values are case sensitive.

Related Product

Alison SDK js

Alison SDK allows developer to integrate Alison Desktop in its pages in a easier way. Go to the Alison SDK documentation.

Alison Desktop

You can obtain current version of Alison Desktop from ACME Alison Wizard site.

For developers, go to the Alison Desktop documentation.

2
minLevel2
indentcircle

Server section



The server object defines the properties necessary to run the embedded Web server. By default the debbie.json file provided is setup to run the Web server on the following URL: "http://localhost:8080/". 


FieldRequiredDescriptionDefault/Example
licenseyesLicense key provided by CertiSur.20180814032223:dW5pdm.............RA==
ipyesWeb server IP address127.0.0.1
portyesWeb server port number.8080
protocolyesWeb server protocol.
http
HTTP
minThreadPoolyes
Minimum
The minimum number of Web server threads.10
maxThreadPoolyes
Maximum
The maximum number of Web server threads.30
timeoutyesInternal Web server timeout.5000

  

Code Block
languagegroovy
themeEclipse
titleServer configuration
{
  "server": {
    "license": "20180814032223:dW5pdmVyc2FsPVo.............RA==",
    "ip": "127.0.0.1",
    "port": 8080,
    "protocol": "http",
    "minThreadPool": 10,
    "maxThreadPool": 30,
    "timeout": 5000
  }
}


For those environments where an SSL proxy/balancer is not available, an SSL certificate can be configured using the ssl object key in the server object definition. For more details of this feature check the user manual.


Code Block
languagegroovy
themeEclipse
titleSSL Configuration example
{
  "server": {
    ...
    "ssl": {
      "keyStoreFile": "ssl/keystore",
      "keyStorePassword": "OBF:1vny1zlp2x9e6vmw1vn61x8g1zau2vn4",
      "keyManagerPassword": "OBF:1u3u4wmn4z5s1z7a5wnl1u2g"
    },
    ...
  }
}


If you use a proxy server to download the CRLs or obtain OCSP responses, the proxy object key must be added in the server object definition.


Code Block
languagegroovy
themeEclipse
titleSample Proxy Access configuration
{
  "server": {
    ...
    "proxy": {
      "server": "proxy.internal.local",
      "port": 3128
    },
    ...
  }
}


Debbie section


The debbie object defines the properties necessary to run the validation service.


FieldRequiredDescriptionDefault
cacheDiryes
Path
The path where offline CRL files are stored when a download script is used.cache/
policyDiryes
Path
The path where the validation policies are stored.policies/

documentRepositoryDir

no
Path
The path where uploaded documents are stored./tmp
urlMaxRedirectsyes
Number
The number of URL redirects supported to access CRL distribution points and OCSP responders.1
crlConnectionTimeoutyesCRL distribution point connection timeout. (msec)2000
crlReadTimeoutyesCRL distribution point read timeout. (msec)5000
ocspConnectionTimeoutyesOCSP responder connection timeout. (msec)2000
ocspReadTimeoutyesOCSP responder read timeout. (msec)5000


Code Block
languagegroovy
titleSample "debbie.json" contents for the "debbie" Object
{
  "debbie": {
    "cacheDir": "cache/",
    "policyDir": "policies/",
    "documentRepositoryDir": "/app/repository",
    "urlMaxRedirects": 1,
    "crlConnectionTimeout": 2000,
    "crlReadTimeout": 5000,
    "ocspConnectionTimeout": 2000,
    "ocspReadTimeout": 5000
  }
}



Sample configuration


Following is the content of the "debbie.json" demo configuration file included in with the validation service distribution.


Code Block
languagegroovy
titleSample Debbie demo configuration file
{
  "server": {
    "license": "20191024050858:dW5pdmVyc2FsPVo.............RA==",
    "ip": "127.0.0.1",
    "port": 8080,
    "protocol": "http",
    "minThreadPool": 10,
    "maxThreadPool": 30,
    "timeout": 5000
  },
  "debbie": {
    "cacheDir": "cache/",
    "policyDir": "policies/",
    "documentRepositoryDir": "/app/repository",
    "urlMaxRedirects": 1,
    "crlConnectionTimeout": 2000,
    "crlReadTimeout": 5000,
    "ocspConnectionTimeout": 2000,
    "ocspReadTimeout": 5000
  }
}


According to this configuration, the validation service is available at "http://localhost:8080". The policy configuration files can be found in "config/policies/".