Wiki

NeoRouterWiki:ConfigurationFiles

From NeoRouterWiki

Jump to: navigation, search

Configuration Files

NeoRouter uses multiple configuration files to control some advanced features. The most useful files are Feature.ini and Log.ini. Feature.ini is used for customizing some internal feature set, performance tuning and debugging purpose. Log.ini is used for tracing application information for troubleshooting.

We provide the file templates as below:

Feature.ini template

#==================================================================
# Feature.ini
#
# This is the feature set configuration file for NeoRouter software.
# If contains the configuration directives that give both client
# and server programs instructions.
#
# This file should be located in the main configuration folder of
# NeoRouter. For NeoRouter Portable, this file can be loaded from 
# the same folder as the executable file.
#
# Any changes to this file won't take into effect until the
# application restarts.
#
# If there is no value assigned to a setting key, default value will
# be choose.
#==================================================================

[Default]
#Description: Current Language LocaleID
#Options:     local ID on Windows
#Default:     1033
LangId=1033

#Description: Current Skin Name
#Options:     Skin file name
#Default:     Office2007.styles
SkinName=Office2007.styles

#Description: Current Skin Style
#Options:     Skin style name
#Default:     NormalBlue.ini or NormalAqua.ini
SkinStyle=NormalBlue.ini

#Description: Create P2P connection between peers
#Options:     0-Disabled; 1-Enabled 
#Default:     1
P2P=1

#Description: Support UDP P2P only (do not try TCP P2P connection)
#Options:     0-Disabled; 1-Enabled 
#Default:     1
UdpOnly=1

#Description: Encrypt packets before sending
#Options:     0-Disabled; 1-Enabled 
#Default:     1
Encrypt=1

#Description: Compress packets between befor sending (without encrption)
#Options:     0-Disabled; 1-Enabled 
#Default:     0
Compress=0

#Description: Compress and encrypt packets before sending
#Options:     0-Disabled; 1-Enabled 
#Default:     0
CompressEncrypt=0

#Description: Number of threads in the thread pool (Windows and Linux ONLY)
#Options:     2*number of CPU cores
#Default:     5
MaxInstanceThreads=5

#Description: Maintain TCP connection using heart beat mechanism
#Options:     0-Disabled; 1-Enabled 
#Default:     1
TcpHeartBeat=1

#Description: The type of heart beat for TCP
#Options:     0-keep ping; 1-ping when idle
#Default:     1
TcpHeartBeatMode=1

#Description: Maintain UDP connection using heart beat mechanism
#Options:     0-Disabled; 1-Enabled 
#Default:     1
UdpHeartBeat=1

#Description: The type of heart beat for UDP
#Options:     0-keep ping; 1-ping when idle
#Default:     1
UdpHeartBeatMode=1

#Description: time interval between keep alive probes
#Options:     >0
#Default:     15 seconds
KeepAliveIntvl=15

#Description: time of connection inactivity after which the first keep alive request is sent
#Options:     >0
#Default:     15 seconds
KeepAliveTime=15

#Description: number of keep alive requests retransmitted before the connection is considered broken. For example, when a client lost network connection for total time = KeepAliveTime + KeepAliveIntvl * KeepAliveProbes, it will be traded as disconnected.
#Options:     >0
#Default:     3 times
KeepAliveProbes=3

#Description: Close the P2P tunnel when it's idle
#Options:     0-Disabled; 1-Enabled 
#Default:     1
AutoDisconnectTunnel=1

#Description: Work with bSupportAutoDisconnectTunnel, time of a tunnel when idle
#Options:     >0
#Default:     600 seconds (10min)
TunnelAliveTime=600

#Description: Keep TCP connection alive
#Options:     0-Disabled; 1-Enabled 
#Default:     1
KeepAlive=1

#Description: Socket Send Buffer
#Options:     > 8KB
#Default:     2097152 Bytes (2MB)
SoSendBuf=2097152

#Description: Socket Recv Buffer
#Options:     > 8KB
#Default:     2097152 Bytes (2MB)
SoRecvBuf=2097152

#Description: Timer for creating p2p tunnel
#Options:     > 600000
#Default:     600000 ms (10 min)
TunnelP2PTimerInterval=600000

#Description: Reset tap device when switch domain (Windows ONLY)
#Options:     0-Disabled; 1-Enabled 
#Default:     1
RestartTap=1

#Description: Virtual IP metric
#Options:     >0
#Default:     9000
VIPMetric=9000

#Description: Run script before tap gets initialized
#Options:     Any script or command
#Default:     
CmdOnTapInit=

#Description: Run script after tap is initialized
#Options:     Any script or command
#Default:     
CmdOnTapActive=

#Description: Run script when tap get uninitialized
#Options:     Any script or command
#Default:     
CmdOnTapUninit=

#Description: Keep custom changes, such as add-ons, DNS cache, proxy and so on
#Options:     0-Disabled; 1-Enabled 
#Default:     1
ForceKeepSetting=1

#Description: Check DNS cache first when parsing NeoRouter Domain Name, instead of calling NeoRouter Domain server
#Options:     0-Disabled; 1-Enabled 
#Default:     1
DNSCache=0

#Description: Interval to refresh DNS cache
#Options:     > 0
#Default:     15 days
DNSCacheExpireTime=15

#Description: Server updates domain server automatically (once a hour)
#Options:     0-Disabled; 1-Enabled 
#Default:     1
AutoUpdateDomain=1

#Description: Trade the log on name as NeoRouter Domain name instead of a computer name
#Options:     0-Disabled; 1-Enabled 
#Default:     1
NRDomain=1

#Description: Alternative server IP address
#Options:     local IP address of the server, in format [domain name],[local ip address]:[port]
#Example:     testdomain,192.168.0.115:32976
#Default:     
AltServer=

#Description: Network Interface name used for getting MAC address
#Options:     the primary network interface having MAC address
#Default:     eth (on Linux) or ed (on FreeBSD)
NicInterfaceName=eth

#Description: Hardware ID for client (it's used when cannot find a valid network interface on Linux)
#Options:     Any unique string
#Default:     
HardwareId=

#Description: Allow to create point-to-site or site-to-site VPN
#Options:     0-Disabled; 1-Enabled 
#Default:     0
NetworkBridge=0

#Description: Hardware ID for client (it's used when cannot find a valid network interface on Linux)
#Options:     Any unique string
#Default:     The parameters are in the format below:
#             LANSegment[nIndex]=[value]
#             [nIndex] is a number (>0);
#             [value] is a string in the format: Network/SubnetMask,VIP
#LANSegment1=192.168.0.100,10.0.0.1
#LANSegment2=192.168.2.0/255.255.255.0,10.0.0.2
#LANSegment3=192.168.3.100-192.168.3.149,10.0.0.3

#Description: Server audits users activities
#Options:     0-Disabled; 1-Enabled 
#Default:     1
Auditing=0

#Description: Max Lines of a Log File, after that a new log file will be created
#Options:     0-unlimited
#Default:     0
MaxNumOfLinesPerLog=0

#Description: Path of the audit file
#Options:     a folder with proper permission
#Default:     main configuration folder
AuditLogFileLocation=

#Description: Specify protocol nrserver uses
#Options:     1-compatible with v1 or v2 clients; 2-clients must be v2.
#Default:     1
ProtocolVersion=1

#Description: Specify host IP type for nrserver
#Options:     0-detect; 1-IPv4; 2-IPv6; 3-Dual
#Default:     0
HostIPType=0

#Description: Max number of client connections that are connecting/authenticating to nrserver
#Options:     > 0
#Default:     10
ServerAuthBacklog=10

#Description: Support Web Gateway
#Options:     0-Disabled; 1-Enabled 
#Default:     1
WebGateway=1

#Description: Support Web Console
#Options:     0-Disabled; 1-Enabled 
#Default:     1
WebConsole=1

#Description: Support Web Client
#Options:     0-Disabled; 1-Enabled 
#Default:     1
WebClient=1

#Description: Whether can sign in with Server host OS user account
#Options:     0-Disabled; 1-Enabled 
#Default:     1
SupportOSUser=1

#Description: Whether disable SSLv3 protocol and use TLS only
#Options:     0-Disabled; 1-Enabled 
#Default:     1
DisableSSLv3=1

#Description: The interval for re-create p2p tunnel. 
#Options:     Seconds. 0 - disabled; suggested value: 10*60
#Default:     0
TunnelP2PRetryInterval=0

#Description: Timeout value of client connections that are connecting/authenticating to nrserver 
#Options:     milliseconds. > 17000
#Default:     17*1000
ServerAuthTimeout=17000

#Description: Min listen port when establishing P2P connection 
#Options:     0 - use port allocated by OS; > 0 specify start port number of the port range, that is used by Client to establish   P2P connections.
#Default:     0
MinP2PListenPort=0

#Description: Max number of retry times to activate Tap
#Options:     >=0
#Default:     12
TapRetryTimes=12

#Description: Before next Tap activation, it waits for n seconds
#Options:     >=0
#Default:     10
TapRetryPeriod=10

#Description: Before verifying Tap status, it waits for n seconds
#Options:     >=0
#Default:     5
TapVerifyInterval=5

Log.ini template

#==================================================================
# Log.ini
#
# This is the logging configuration file for NeoRouter software.
# If contains the configuration directives that give both client
# and server programs instructions.
#
# This file will be searched in the following paths:
# 1. the same folder as the executable file
# 2. the main configuration folder
#
# Any changes to this file won't take into effect until the
# application restarts.
#
# If there is no value assigned to a setting key, default value will
# be choosen. 
#
# If a specific application section gets defined, the values in the
# [Default] section would be replaced with the specific values if 
# it is re-defined
#
#MASK
#  Format: FF FFFFFF = Level Modules
#  ALL   : FF FFFFFF = 4294967295
#  TRACE : 3F FFFFFF = 1073741823
#  DEBUG : 1F FFFFFF = 536870911
#  INFO  : 0F FFFFFF = 268435455
#  WARN  : 07 FFFFFF = 134217727
#  ERROR : 03 FFFFFF = 67108863
#  FATAL : 01 FFFFFF = 33554431
#==================================================================
#TYPE:
#
#  1-File; 2-DebugView; 4-UDP; 8-Pipe
#==================================================================
#PATH:
#
#  File: it is the folder name where the log file will be stored
#  UDP :  it is the IP address of the Log Viewer
#==================================================================
#Flags:
#  1 - true (default)
#  0 - false
#==================================================================
#RULES:
#
#  The values defined in sub section will replace the Default values,
#  if it's not empty. If it's empty, the default value will be used
#
#==================================================================

[Default]
#Description: Error type and modules mask
#Options:
#     ALL   : FF FFFFFF = 4294967295
#     TRACE : 3F FFFFFF = 1073741823
#     DEBUG : 1F FFFFFF = 536870911
#     INFO  : 0F FFFFFF = 268435455
#     WARN  : 07 FFFFFF = 134217727
#     ERROR : 03 FFFFFF = 67108863
#     FATAL : 01 FFFFFF = 33554431
#Default:     536870911
Mask=536870911

#Description: Logging target type
#Options:     0-Disable logging; 1-File; 2-DebugView|Print message to console|Android logger; 4-UDP
#Default:     0
Type=0

#Description: Log file folder or IP address of the log viewer
#Options:     any folder with proper permission
#Default:     default main configuration folder
#Samples:
#Path=C:\Documents and Settings\All Users\Application Data\ZebraNetworkSystems\NeoRouter
#Path=/usr/local/ZebraNetworkSystems/NeoRouter
#Path=192.168.0.100
Path=

#Description: Max lines of each log file
#Options:     0-Do not split logging file; >0 - save logging information to multiple files
#Default:     0
MaxNumOfLines=0

#You can also define specific logging settings for a specific application

#Description: Section name of an application
#Options:     Executable file name (without extension name), it's case-sensitive
#Default:     
#[NRClient]
#Mask=4294967295
#Type=4
#Path=192.168.0.100
#MaxNumOfLines=20000

#[NRConsole]
#Mask=4294967295
#Type=4
#Path=192.168.0.100
#MaxNumOfLines=20000

#[NRServer]
#Mask=4294967295
#Type=0
#Path=
#MaxNumOfLines=20000

#[nrserver]
#Mask=4294967295
#Type=1
#Path=/var/neorouter/log/nrserver
#MaxNumOfLines=20000

#[nrservice]
#Mask=4294967295
#Type=1
#Path=/var/neorouter/log/nrservice
#MaxNumOfLines=20000

#[nrclientcmd]
#Mask=4294967295
#Type=1
#Path=/var/neorouter/log/nrclientcmd
#MaxNumOfLines=20000