Installation

The DAV Web Service is available to download from a gsd-dav folder.

Requirements

Linux

  • 64 bits version

Windows

  • 64 bits version

Service

Configuration wizard

One of the possible options for configuring our services is to use our configuration wizard. It make basic configuration easier.

Configuration wizard will run automatically when configuration file was not found. Also is additional possibility to run configuration wizard by run application with the following parameter: 

1
$  --edit-config
WebDav Service configuration should begin with double installation of provided file **ma-dav.exe**. After performing this procedure in the folder where the **ma-dav.exe** is located, configuration file: **dav-service-config.yml**, will be created. The necessary configuration of this file is possible in any text editor.


Using quotes in config values

We recommend to miss quotes or use single quotes in config values, because those values are not interpreted. According to YAML specification, values which are surrounded with double quotes are interpreted, so it can cause errors during reading config values.

Proxy configuration

ProxyAlias field must be left as empty if you are not using GSD-ProxyServer. If you want to use GSD-ProxyServer, WebDav service will be accessible only via GSD-ProxyServer. If you want to use GSD-ProxyServer with WebDav service please copy alias value that is assigned to WebDav service from GSD-ProxyServer configuration to ProxyAlias field in WebDav configuration.


In the dav-service-config.yml file:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
ip: 127.0.0.1
port: 8881
ssl:
    enabled: true
    privateKeyPath: ./certificate/localhost.key
    certificatePath: ./certificate/localhost.crt
databases:
    -
        rasServer: 127.0.0.1
        rasServerPorts:
            - 54332
        databaseServer: 127.0.0.1
        databaseName: DAV
        timeout: 9000
        readTimeout: 10000
        maxNumOfInstances: 15
        databaseAlias: ""
        userName: GSDWebService
        password: ""
        proxyAlias: ""
connection:
    acquireTimeoutMilliseconds: 10000
    idleTimeoutMilliseconds: 10000
    minimum: 0
    maximum: 10
statistics:
    enabled: false
logger:
    trimLogs: false
    maximumLogCharacters: 1000
    ansiColoring: true
checkService:
    enabled: true

the following items should be filled:

Field Description
ip address bound to WebDAV service
port port bound to WebDAV service
ssl/enabled boolean which tells that ssl is enabled (default true)
ssl/privateKeyPath path to ssl private key
ssl/certificatePath path to ssl certification key (.crt file)
databases/rasServer ip of the remote access server
databases/databaseServer ip of the database server
databases/databaseName database name
databases/databaseAlias database alias, default value can by empy: ""
databases/timeout timeout
databases/readTimeout readTimeout
databases/maxNumOfInstances maximun number of open connection
databases/proxyAlias proxy alias used in GSD-ProxyServer
connection connection pool configuration
statistics enables statistics gathering. More info
logger logger config


Field Description
checkService checkService configuration
checkService/enabled false / true

After configuring ma-dav.yml web service can be run again in order to start up the application.

Multiple database configuration

In default configuration there exist only one entry with empty databaseAlias field. In this case all http routes will be available without databaseAlias prefix value. In order to configure multiple databases for one web service one has to add additional entries to databases array in dav-service-config.yml file. Every entry should have an unique databaseAlias value. For example, let's use following configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  ...
  databases:
    -
        rasServer: 127.0.0.1
        rasServerPorts:
            - 54332
        databaseServer: 127.0.0.1
        databaseName: DAV
        timeout: 9000
        readTimeout: 10000
        maxNumOfInstances: 15
        databaseAlias: db1
        userName: GSDWebService
        password: ""
        proxyAlias: proxy1
    -
        rasServer: 127.0.0.1
        rasServerPorts:
            - 54332
        databaseServer: 127.0.0.1
        databaseName: DAV
        timeout: 9000
        readTimeout: 10000
        maxNumOfInstances: 15
        databaseAlias: db2
        userName: GSDWebService
        password: ""
        proxyAlias: proxy1

  ]
  ...
}

In above example database DAVDB will be available without databaseAlias prefix value. For instance: https://192.168.1.20:8888/p/userName. However, so as to synchronize AnotherDAVDB one has to add db1 prefix to all http requests. For instance https://192.168.1.20:8888/db1/p/userName.

Warning

In case of using many database for one WebDav service all databases must have aliases.

Service startup

To run application as a service, we need to run run.service.bat (Web Service location) as administrator and answer for questions:
Do you want send statistic to GSD?[Y/N] - If you agree for sending statistic to GSD, we will be able to get better diagnostic information about possible WebService's problems and update licenses automatically.
Enter the service identifier [GSD-service-name(-yourId)] - If you want run more than one service on the system, you must add a unique ID for everyone. [default=GSD-service-name]