GSD-Proxy-Server Installation


The GSD-Proxy-Server is available to download from a gsd-proxy-server folder.

Linux:

Requirements:

  • openssl

Running as a service:

Please refer to the guide here: https://docs.gsd.pl/restapi/information/installation/ under Linux/MacOS section.

Proxy Service Configuration

To start the gsd-proxy you must run the gsd-proxy-server.exe file. By the first start it will create proxy-server-config.yml file. The necessary configuration of the configuration file is possible in any text editor. After the second start of gsd-proxy-server.exe file, the Web Service will start normally.


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.


In the proxy-server-config.yml file:

name:

Application identifier. May be used in logs.

loggerConfig:

trimLogs:

Turn on if you want to trim part of logs.

maxLogLength:

Number of characters from the begging you want to preserve in a console when trimLogs is enabled.

prettyPrint:

Enables log coloring. If your logs do not color and contain strange characters then turn this option off.

This feature requires an ANSI support in console.

It is enabled by default on Windows 10 and Unix. Older operating systems do not support it.

services [array]:

address:

address of webservice to register

port:

port of webservice

alias:

[Since 2.0.0] prefix to the path on which the web service will be accessible

registerPath:

DEPRECATED [Since 2.0.0] path to register particular web service in proxy server, for gsd projects this should have default value '/proxy/pathRegister'

listeners [array]:

Listeners on which application will wait for client's requests.

HTTP2 and HTTPS require keys and certificates.

Keep in mind that you should always use your own certificate. The ones bundled with the app do not guarantee maximum security and should only be used in non-production environments.

type:

type of listener, Available listeners: HttpListener, HttpsListener, Http2Listener

port:

port

enabled:

true/false

serverKey [for https]:

key for server in *.pem file

serverCert [for https]:

certificate for server in *.pem file