INI-File of Valentina Server

Valentina Server uses an INI file containing key–value pairs for properties, and sections that organize the properties for controlling default settings of Valentina Server. You can open this file with a text editor, change settings and save it.

; - a comment that starts a comment up to the end of the line.

[] - a comment that shows the name of a parameters group.

If you trash ini file in the VServer folder, then on the next start Valentina Server will generate a new one with the default settings. It looks as the following:

[LOGGING]

; Enables logging to the console.
LogToConsole=1

; Enables logging to the file.
LogToFile=1

; Specifies the time in minutes to check the current log to be split.
; 0 - means infinite timeout.
SplitLogFileTimeOut=5

; Specifies the size in MB to check the current log to be split
SplitLogFileSize=20

; Enables splitting for log-file to avoid lengthy logs.
SplitLogFile=1

; Specifies file-log location.
LogFilesFolder=vlogs

; Enables logging to the syslog.
LogToSysLog=0

; Specifies how much information produce in logs:
; 0 - display error messages only.
; 1 - display errors and warnings.
; 2 - display errors, warnings, and debugging messages.
; 3 - display errors, warnings, debugging messages, and command level tracing.
VerboseLevel=1

; Any query which takes more than this time (in seconds) will be treated as slow.
; 0 - means no log for slow queries (default value).
SLOWQUERYTIME=0


[VKERNEL]

; The size of the database cache in MB.
CacheSize=10

; 1 - Enable mail features in vKernel.
; 0 - Disable mail features in vKernel.
MailEnable=0

; 1 - Enable UDP message features in vKernel.
; 0 - Disable UDP message features in vKernel
UDPMessageEnable=0

[GENERAL]

; If 1 then disables DNS resolving. 0 - Enabled.
DisableDNS=1

; If 0 then vServer properties are changeable.
HostingMode=0

; If 1 then it is a slave server (RO access only).
SlaveMode=0

; Specify access control list (ACL). ACL is a comma-separated list of IP subnets, 
; each subnet is prepended by '-' or '+' sign. Plus means allow, and minus means deny.
; If the subnet mask is omitted, like "-1.2.3.4", then it means a single IP address.
; Mask may vary from 0 to 32 inclusive. On each request, the full list is traversed,
; and the last match wins.
; The default setting is to allow all (empty list).
; For example, to allow only the 192.168/16 subnet to connect - "-0.0.0.0/0,+192.168.0.0/16".
;AccessControlList=

; If 0 then vServer allows multiple connections with the same login.
SingleConnectionPerLogin=0

; Specifies the IDLE timeout in minutes for a client.
; On timeout VServer will disconnect that client.
; 0 - means infinite timeout.
MaxIdleClientTimeout=20

; Specifies the CONNECTION timeout in seconds for a client.
; 0 - means no timeout.
MaxConnectionTimeout=20

; Specifies the TRANSFER timeout in seconds for a client.
; 0 - means no timeout.
MaxTransferTimeout=20

; Specifies the sleep time in seconds after vServer starts (vServer is ready but doesn't respond to client connect requests).
; 0 - means no sleep time.
InitSleepTime=0

; Non-secure port to listen. 0 - not listen.
Port=15432

; How many threads to have in pool. Range 1-N.
Threads=5

; The path, where licenses are stored.
LicenseFolder=licenses

; The path, where projects are stored.
SystemProjectFolder=projects

; The path, where sysdatabase is stored.
SystemFolder=Databases


; The full path, where backups are stored. (Folder must exist)
; param absence - means - clients may choose any folder on the server.
; SystemBackupFolder=

; The path, where SSH keys are stored.
SystemSSHkeySFolder = SSH_Keys

; 1 - Allow receiving not-encrypted passwords.
; 0 - Reject connection with not-encrypted passwords.
UseOldPasswords=0

; 1 - Flush after any data modification.
; 0 - Default value - no flushing.
FlushEachDataChanges=0

; 1 - Check privileges.
; 0 - Default value - no privileges checks.
PrivilegesEnable=0

; If 1 then registered databases will be open on vServer start.
EarlyOpeningDatabases=0


[HTTP]
; Port to listen to HTTP protocol.
; 0 - do not use HTTP port.
Port_HTTP=0

[SSL]
; Secure port to listen by VServer.
; 0 - do not use a secure port.
Port_SSL=15434

; The path, where a certificate is stored.
SSL_Certificate=dummy.pem

; The path, where a private key is stored.
SSL_PrivateKey=key.pem

[SNMP]
; SNMP port to listen by VServer.
; 0 - do not use a SNMP port.
Port_SNMP=15161

[BONJOUR]
; 1 - Try to register in bonjour service.
; 0 - Do not try register.
BonjourEnable=1

; The protocol name of the VServer.
BonjourProtocolName=valentina

; The service name of the VServer.
;BonjourServiceName=

[SCHEDULE]
; 1 - Run scheduler.
; 0 - No scheduler.
ScheduleEnable=0

[CRASHREPORTER]
; 1 - Send crash reports.
; 0 - Don't send crash reports.
Crash_Reporter_Send=1

; Optional but very recommended to specify.
; Crash_Reporter_Owner_Name=

; Optional but very recommended to specify.
; Crash_Reporter_Owner_Email=


[SQLITE]
; The path, where sqlite databases are stored.
SQLITESYSTEMFOLDER = databases_sqlite

; Non-secure port to listen to Sqlite connections. 0 - not listen.
PORT_SQLITE = 15532

; Secure port to listen to Sqlite connections. 0 - not listen.
PORT_SQLITE_SSL = 15534

[REST]
; Port to listen to REST clients.
; 0 - do not use REST port.
Port_REST = 8080

; Optional - Port to listen to REST SSL clients.
; 0 - do not use REST SSL port.
;Port_REST_SSL=0

; Optional - The path, where a certificate is stored (The file must contain both - public certificate and private key).
;REST_SSL_Certificate=

NOTE: Added in v5.7

Specifies access control list (ACL).

ACL is a comma-separated list of IP subnets. Each subnet is prepended by '-' or '+' sign. Plus means allow, and minus means deny. If a subnet mask is omitted, like “-1.2.3.4”, then it means a single IP address. Mask may vary from 0 to 32 inclusive.

On each request, the full list is traversed, and the last match wins.

The default setting is to allow all (empty list).

For example, to allow only the 192.168/16 subnet to connect - “-0.0.0.0/0,+192.168.0.0/16”.

Specifies the needs of registering for the Bonjour service.

Specifies Bonjour protocol name for the Valentina Server.

Specifies Bonjour service name for the Valentina Server.

The cache size (in MB) of the database engine.

If 1 - send vServer crash reports.

Optional but very recommended to specify vServer's owner name.

Optional but very recommended to specify vServer's owner email.

If 1, VServer does not try to resolve the name of a host using DNS (faster), and shows only its IP address.

Specifies the need for immediate flushing after each database changes. Use this feature only for debugging purposes. Do not build the logic of your code on it, i.e. your code should self-fix changes when this is required.

NOTE: Added in v4.8

If 0 then vServer properties are changeable. If not zero you can not change any ini property even with admin privilege.

If 1 then it is a slave server (RO access only).

[NEW v.7.3.5] The path to a folder where Valentina Server's licenses are stored.

Specifies if VServer will print messages into the console. Printing into the console can be useful during development time, but it slows down significantly the speed of the server. See also: VerboseLevel parameter.

Specifies if VServer will print messages into the log file. See also: VerboseLevel parameter.

Specifies where the logs (vserver and vkernel logs) would be placed in. The default value is 'vlogs'.

Specifies if VServer will print messages into the system log (event log for Windows and syslog for Linux). See also: VerboseLevel parameter.

Enable/disable mail features in vKernel.

Enable/disable UDPMessage feature in vKernel.

NOTE: Added in v4.0

Specifies the CONNECTION timeout in seconds. Connecting to the server user may be held until rather a timeout exceeds or some connection has been freed.

Specifies the IDLE timeout in minutes for a client. On timeout, VServer will disconnect that client. This option protects VServer from users, which have forgotten to disconnect and go for a cup of coffee.

Specifies the TRANSFER timeout in seconds for a client. 0 - means no timeout.

Specifies the sleep time in seconds after vServer starts (vServer is ready but doesn't respond to client connect requests). 0 - means no sleep time.

Specifies the non-secure port, which the vserver will listen to. This allows you to have a few Valentina Servers on the same computer. On default it is for:

• VServer Office - 15432
• VServer Embedded - 15434

Set it to Zero if you do not need this feature.

Specifies the HTTP port, which the Server will listen for HTTP protocol. Set it to ZERO if this feature is not needed.

Specifies the port, which the Server will listen for REST connections. Set it to ZERO if this feature is not needed.

Specifies the SSL port, which the Server will listen for REST connections. Set it to ZERO if this feature is not needed.

Specifies the SSL port, which the Server will listen for secure connections. On default it is for:

• VServer Office - 15433
• VServer Embedded - 15435

Set it to ZERO if this feature is not needed.

Specifies the SNMP port, which the Server will listen for SNMP protocol. By default, it is for

• VServer Office - 15161
• VServer Embedded - 15162

Set it to ZERO if this feature is not needed.

Specifies the port, which the Server will listen for SQLite connections. Set it to ZERO if this feature is not needed.

Specifies the SSL port, which the Server will listen for SQLite connections. Set it to ZERO if this feature is not needed.

Specifies the need to check the user privileges.

If 1 then registered databases will be open on vServer start.

The path to a file that is a certificate for REST secure communication. The file must contain both - a public certificate and a private key.

Specifies whether the scheduler must be running or not. The default state is ON. The scheduler allows you to do regular jobs, like backups.

Note that CREATE/DROP and ALTER events are always possible even if the scheduler is not running, in this case, changes just will go into the master database of VServer and start play when and if you will set this option ON.

[read more ...]

If 0 then vServer allows multiple connections with the same login.

The path to a folder where SQLite databases will be stored.

The path to a file is a certificate for secure communication. Valentina Server has a demo file. Never use it in real deployment to your customers!!!

The path to a file is a private key for secure communication. Valentina Server has a demo file. Never use it in real deployment to your customers!!!

The path to a folder where will be stored databases managed by Valentina Server.

If you change it, you should copy/move existing databases there yourself. Also, you should unregister all databases and register them back, because the master database keeps the full path to the databases inside.

The path to a folder where will be stored vProjects managed by Valentina Server.

If you change it, you should copy/move existing projects there yourself. Also, you should unregister all projects and register them back, because the master database keeps the full path to the projects inside.

The full path, where backups are stored. Param absence - means - default location - “backup” inside vServer folder.

The full path, where SSH keys for Valentina Reports data sources are stored. Param absence - means - default location - “SSH_Keys” inside vServer folder. Keys can be added either manually or automatically during a preview within Valentina Studio.

[NEW v.13.0] Enables splitting for log-file to avoid lengthy logs. The default value is true. vServer checks the length of the current log file every 5 minutes and if its length is more than 20Mb starts a new log.

NOTE: Added in 13.1

Specifies the time in minutes to check the current log to be split. Zero means - no split. The default value is - 5 minutes.

NOTE: Added in 13.1

Specifies the size in MB to check the current log to be split. The default value is - 20Mb.

[NEW v.13.0] Any SQL query which takes more than this time (in seconds) will be treated as slow and will come to the slow-query dedicated log file. Zero (default value) means no logging.

Specifies the number of threads in the thread pool. Recommended are between 1 - 20. The default is 5. Do not set this value too big unless you have a really multi-CPU computer.

Deprecated. Specifies allowance of accepting not-encrypted passwords from the clients. In most cases, not-encrypted passwords should not be used.

Specifies how much information VServer will print into the log/console. The following are values that you can use in the order of growth of verbose:

• LogVerbose = 0 - print only errors.
• LogVerbose = 1 - print errors + warnings.
• LogVerbose = 2 - print erros + warnings + debugging messages.
• LogVerbose = 3 - print also command trancing.