R66ServerConfig

Waarp R66 Server Configuration File

config

  • comment:string Optional

identity

  • hostid:nonEmptyString

    Host ID in NON SSL mode

  • sslhostid:nonEmptyString Optional

    Host ID in SSL mode

  • cryptokey:Des-File

    Des CryptoKey File containing the key in Des mode for R66 passwords

  • authentfile:XML-File Optional

    Authentication File containing Authentications for partners

server

  • serveradmin:nonEmptyString

    Username for Administrator access

  • serverpasswd:nonEmptyString or serverpasswdfile:nonEmptyString

    Password for Administrator access using Crypto Key (directly or through a ggp file)

  • usenossl:booleanType default="True"

    True (Default) if R66 will allow no SSL mode connection

  • usessl:booleanType default="False"

    True if R66 will allow SSL mode connection

  • usehttpcomp:booleanType default="False"

    True if Administrator (HTTPS) will allow HTTP compression

  • uselocalexec:booleanType default="False"

    By default, use the System.exec() but can lead to limitation in performances (JDK limitation). The usage of the GoldenGate LocalExec Daemin tends to reach better performances through execution delegation

  • lexecaddr:address default="127.0.0.1" Optional

    Address of LocalExec Daemon

  • lexecport:nonNulInteger default="9999" Optional

    Port of LocalExec Daemon

  • httpadmin:directoryType

    Home Directory for HTTPS file support for Administrator

  • admkeypath:JKS-File

    JKS HTTP KeyStore for Administrator Access in HTTPS Mode (containing Server Certificate)

  • admkeystorepass:nonEmptyString

    Password for the HTTP KeyStore

  • admkeypass:nonEmptyString

    Password for the HTTP Server Certificate within the HTTP KeyStore

  • checkaddress:booleanType default="False" Optional

    True if R66 will check remote IP address while accepting a new connection

  • checkclientaddress:booleanType default="False" Optional

    True if R66 will check remote IP address also for remote Client

  • multiplemonitors:nonNullInteger default="1"

    Set the number of servers that act in the same group as a single instance of OpenR66 File Transfer Monitor

  • businessfactorynetwork:nonEmptyString if specified

    If you need a special Business Factory, you must specify the full class name here.

    Default is: org.waarp.openr66.context.R66DefaultBusinessFactory which only logs in DEBUG mode.

network

  • serverport:nonNulInteger default="6666"

    Port used in NON SSL mode

  • serversslport:nonNulInteger Optional default="6667"

    Port used in SSL mode

  • serverhttpport:nonNulInteger default="8066"

    Port used for monitoring in HTTP mode, 0 for inactive

  • serverhttpsport:nonNulInteger default="8067"

    Port used for Administrator access in HTTPS mode, 0 for inactive

  • serverrestport:nonNulInteger default="-1"

    Port used for REST API in HTTP(s) mode (-1 means not activated)

ssl Optional

  • keypath:JKS-File

    JKS KeyStore for R66 Access in SSL Mode (containing Server Certificate)

  • keystorepass:nonEmptyString

    Password for the KeyStore

  • keypass:nonEmptyString

    Password for the Server Certificate within the KeyStore

  • trustkeypath:JKS-File

    JKS Trust KeyStore for R66 Access in SSL Mode with Client Authentication (containing Client Certificate)

  • trustkeystorepass:nonEmptyString

    Password for the Trust KeyStore

  • trustuseclientauthenticate:booleanType default="False"

    True if R66 will only allow client through SSL authentication

directory

  • serverhome:directoryType

    Home Directory for the OpenR66 Server (relative path to this Home)

  • in:nonEmptyString Optional default="IN"

    Default Receive Directory

  • out:nonEmptyString Optional default="OUT"

    Default Send Directory

  • arch:nonEmptyString Optional default="ARCH"

    Default Archive Directory

  • work:nonEmptyString Optional default="WORK"

    Default Working Directory

  • conf:nonEmptyString Optional default="CONF"

    Configuration Directory

limit

  • serverthread:nonNulInteger default="number of core * 2 + 1" Optional

    Number of Threads on Server side (=Number of Cores * 2 + 1)

  • clientthread:nonNulInteger default="10" Optional

    Number of Threads on Client side (=10xServer)

  • memorylimit:nonNulInteger default="4000000000" Optional

    Memory Limit for R66 Server Java Process

  • sessionlimit:nonNegInteger default="8388608" Optional

    HBandwidth for one session (64Mb)

  • globallimit:nonNegInteger default="67108864" Optional

    Global Bandwidth (512Mb)

  • delaylimit:nonNulInteger default="10000" Optional

    Delay between 2 checks of Bandwidth (10s). The less this value, the better the bandwidth limitation is done. However take care to not give too low value

  • runlimit:nonNulInteger default="10000" Optional

    Limite by batch of active transfers (10000)

  • delaycommand:nonNulInteger default="5000" Optional

    Delay between 2 execution of the Commander (5s)

  • delayretry:nonNulInteger default="30000" Optional

    Delay between 2 attemps in case of error (30s)

  • timeoutcon:nonNulInteger default="30000" Optional

    Delay before a Time Out occurs (30s)

  • blocksize:nonNulInteger default="65536" Optional

    Block size (64Ko). A value between 8 KB to 16 MB is recommanded

  • gaprestart:nonNulInteger default="30" Optional

    Gap to use when restarting a transfer as gap x blocksize

  • usenio:booleanType default="False" Optional

    Usage of NIO support for the files. According to the JDK, it can enhance the performances

  • usecpulimit:booleanType default="False" Optional

    Usage of CPU Limitation when new request starts

  • usejdkcpulimit:booleanType default="False" Optional

    Usage of CPU limitation based on Native JDK support, else (False) on Java Sysmon library

  • cpulimit:decimalType default="0.0" Optional

    Usage of CPU limitation based on Native JDK support, else (False) on Java Sysmon library ; 1.0 means NO LIMIT, else limit of global CPU usage

  • connlimit:nonNegInteger default="0" Optional

    Usage of connexion limitation based on Native JDK support, else (False) on Java Sysmon library ; 0 means NO LIMIT, else limit of concurrent number of connexions

  • digest:integerNotNegative default=0 (to setup a different Digest than MD5 globally)
  • usefastmd5:booleanType default="True"

    Usage of FastMD5 library. The library greatly improves the performances for the MD5 computations

  • fastmd5:SODLL-File Optional

    Library JNI Filepath. If the path is empty, the pure Java version will be used

  • checkversion:booleanType Optional default="False"

    If True, it will enable extended protocol (>= 2.3) to enable some extra information getting back at end of transfers

  • globaldigest::booleanType Optional default="True"

    If True, it will enable a global digest (MD5, SHA1, ...) per file per transfer

db

  • dbdriver:address

    4 types of database are currently supported: oracle, mysql, postgresql, h2

  • dbserver:normString

    Connection to the database in JDBC mode (jdbc:type://[host:port]....). Use the database documentation to find the correct syntax for the JDBC connection

  • dbuser:address

    Database User

  • dbpasswd:nonEmptyString

    Database User's Password

  • dbcheck:boolean 

    Database check activation at startup (default True)

  • taskrunnernodb:booleanType Optional default="False"

    When server with no DB, do R66 will use XML files as permanent information on Transfer Tasks

rest

  • restssl:booleanType Optional default="False"
    Is the SERVER REST interface using SSL
  • restdelete:booleanType Optional default="False"
    Is the SERVER REST interface allowing delete
  • restauthenticated:booleanType Optional default="False"
    Is the SERVER REST interface using authentication
  • resttimelimit:long Optional default="-1"
    Is the SERVER REST interface using time limit
  • restauthkey:pathType Mandatory
    SERVER REST interface SHA 256 Key file for request checking

business

  • businessid:nonEmptyString

    the host ids (1 by 1) that will be allow to use Business Request (>= 2.3)

roles

  • role 

     

    If specified for one host, this will override database roles for ALL hosts (from version 2.4.9). By default, local server should be added as role = FULLADMIN.

    • roleid:nonEmptyString

      The host ids (1 by 1) that will override database roles

    • roleset:nonEmptyString with separators as blank or '|' 

      The role assign to this host between NOACCESS,READONLY,TRANSFER,RULE,HOST,LIMIT,SYSTEM,LOGCONTROL,PARTNER(READONLY,TRANSFER),CONFIGADMIN(PARTNER,RULE,HOST),FULLADMIN(CONFIGADMIN,LIMIT,SYSTEM,LOGCONTROL)

aliases

  • alias

    This will allow alias usage for host ids (from version 2.4.12).

    • realid:nonEmptyString

      The real host id that will have aliases (locally)

    • aliasid:nonEmptyString with separators as blank or '|' 

      The set of aliases assign to this host

Example:

<?xml version="1.0" encoding="UTF-8"?>
<config xmlns:x0="http://www.w3.org/2001/XMLSchema">
    <comment>Example of config file: change its as your need.</comment>
    <identity>
        <hostid>hosta</hostid>
        <sslhostid>hostas</sslhostid>
        <cryptokey>D:\GG\R66\certs\test-key.des</cryptokey>
        <authentfile>D:\GG\R66\conf\OpenR66-authent-A.xml</authentfile>
    </identity>
    <server>
        <serveradmin>monadmin</serveradmin>
        <serverpasswd>c5f4876737cf351a</serverpasswd>
        <usenossl>True</usenossl>
        <usessl>False</usessl>
        <usehttpcomp>False</usehttpcomp>
        <uselocalexec>False</uselocalexec>
        <httpadmin>D:\NEWSOURCE\GoldenGateR66\src\main\admin</httpadmin>
        <admkeypath>D:\GG\R66\certs\testsslnocert.jks</admkeypath>
        <admkeystorepass>testsslnocert</admkeystorepass>
        <admkeypass>testalias</admkeypass>
        <checkaddress>False</checkaddress>
        <checkclientaddress>False</checkclientaddress>
    </server>
    <network>
        <serverport>6666</serverport>
        <serversslport>6667</serversslport>
        <serverhttpport>8066</serverhttpport>
        <serverhttpsport>8067</serverhttpsport>
    </network>
    <ssl>
        <keypath>D:\GG\R66\certs\testsslnocert.jks</keypath>
        <keystorepass>testsslnocert</keystorepass>
        <keypass>testalias</keypass>
        <trustkeypath>D:\GG\R66\certs\testcert.jks</trustkeypath>
        <trustkeystorepass>testcert</trustkeystorepass>
        <trustuseclientauthenticate>True</trustuseclientauthenticate>
    </ssl>
    <directory>
        <serverhome>d:/GG/R66</serverhome>
        <in>in</in>
        <out>out</out>
        <arch>arch</arch>
        <work>work</work>
        <conf>conf</conf>
    </directory>
    <limit>
        <usefastmd5>True</usefastmd5>
        <fastmd5>D:\NEWJARS\gglib\win32\MD5.dll</fastmd5>
        <delayretry>10000</delayretry>
        <timeoutcon>10000</timeoutcon>
        <serverthread>8</serverthread>
        <clientthread>80</clientthread>
        <memorylimit>4000000000</memorylimit>
        <sessionlimit>8388608</sessionlimit>
        <globallimit>67108864</globallimit>
        <delaylimit>10000</delaylimit>
        <runlimit>10000</runlimit>
        <delaycommand>5000</delaycommand>
        <blocksize>65536</blocksize>
        <gaprestart>30</gaprestart>
        <usenio>False</usenio>
        <usecpulimit>False</usecpulimit>
        <usejdkcpulimit>False</usejdkcpulimit>
        <cpulimit>0.0E1</cpulimit>
        <connlimit>0</connlimit>
    </limit>
    <db>
        <dbdriver>h2</dbdriver>
        <dbserver>jdbc:h2:D:/GG/R66/data/openr66;IFEXISTS=TRUE;MODE=Oracle;AUTO_SERVER=TRUE</dbserver>
        <dbuser>openr66</dbuser>
        <dbpasswd>openr66</dbpasswd>
    </db>
</config>