Configuration

Net-Api v2.0.3

name:

Application identifier. May be used in logs.

sessionTimeoutInSec:

If user is inactive for the amount of seconds defined in this variable then the session will be logged out.

tmpDir:

Temporary directory in which the files will be stored for DOCUframe. Both Net-Api and DF must point to the same direction in order to make upload work.

uploadFileStoreTimeInSec:

Time after the file will be deleted after the upload.

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.

connectionPoolConfig:

Connection pool is a set of objects that have connection to the DOCUframe. This eliminates a need to recreate socket connection when you experience high traffic.

acquireTimeoutMillis:

Time after client will be timed out. It will work when the number of current connections is equal to maximum connections allowed.

idleTimeoutMillis:

The time after connection socket will be disconnected and removed.

min:

Minimum number of connections that stay available for clients.

max:

Maximum number of simultaneous connection to DOCUframe.

sessionPoolConfig:

Session pool stores every connected user and their session ids.

driver:

Tells which driver should handle session storage. Using memory will allow users to connect only to the single instance of this app. This means that if you have two application running then you must log to each separately.

redis:

host:

IP address of redis application.

port:

Redis port.

primaryDb:

Primary database which stores user sessions.

secondaryDb:

Secondary database which stores generic application data.

memory:

Setting's placeholder. May be used in future.

rasServerIP:

IP of the RAS (Remote Access Server) to which you wish to connect.

rasServerPorts:

Array of ports the RAS is listening. When you have multiple ports then the first to respond will handle your request.

databaseServerIP:

IP of the Database Server.

databaseName:

Path or alias of the database.

userName:

Username which will init the connection.

userPassword:

MD5 hash of the user's password.

timeout:

DOCUframe request timeout in seconds.

databases:

Array of additional databases you wish to use.

maxSessionLoad:

Maximum amount of request that single session can make.

listeners:

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.

apiV2SecureConfig:

Enables second layer of encryption. Application was tested with PKCS 1 or 8 key standard.

publicKeyPath:

Path where public key exists. Will be generated if does not exists.

privateKeyPath:

Path where private key exists

salt:

String of random characters.

This option makes your AES keys much more secure and cryptographically safe.

Info

This string should not be generated using electronic device. Just type random 10 to 20 characters from your keyboard.

enabled:

Enables secure routes registration. If disabled then keys will not generate.

clusterConfig:

Deprecated. Will be removed in near future.

proxyConfig:

Deprecated. Will be removed in near future.

limitterConfig:

Deprecated. May be removed in near future.

loginLimitterConfig:

Deprecated. May be removed in near future.