Switch to: V9V8V7V6V5

INI-File of Valentina Server

Valentina Server uses an ini-file, known as a Windows ini file. You can open this file by a text editor, change settings and save it. Changes will affect on the next start of Valentina Server.

Comments

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

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

Default ini File

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 file-log location.
LogFilesLocation=vlogs

; Enables logging to the syslog.
LogToSysLog=0

; Specifies how many information produce into 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

[VKERNEL]

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

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

[GENERAL]

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

; If 0 then vServer properties are changeable.
HostingMode=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, minus means deny.
; If subnet mask is omitted, like "-1.2.3.4", then it means single IP address.
; Mask may vary from 0 to 32 inclusive. On each request, full list is traversed,
; and last match wins.
; Default setting is to allow all (empty list).
; For example, to allow only 192.168/16 subnet to connect - "-0.0.0.0/0,+192.168.0.0/16".
;AccessControlList=

; If 0 then vServer allow 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

; 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.
LicenseCatalog=licenses

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

; The path, where sysdatabase are stored.
SystemCatalog=Databases


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

; 1 - Allow to receive 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

[HTTP]
; Port to listen 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.
SQLITESYSTEMCATALOG = databases_sqlite

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

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

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

; Optional - Port to listen 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=

Parameters Description

AccessControlList

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, minus means deny. If subnet mask is omitted, like ”-1.2.3.4”, then it means single IP address. Mask may vary from 0 to 32 inclusive.

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

Default setting is to allow all (empty list).

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

BonjourEnable

Specifies the needness of registering to the Bonjour service.

BonjourProtocolName

Specifies Bonjour protocol name for the Valentina Server.

BonjourServiceName

Specifies Bonjour service name for the Valentina Server.

CacheSize

The cache size (in MB) of database engine.

Crash_Reporter_Send

If 1 - send vServer crash reports.

Crash_Reporter_Owner_Name

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

Crash_Reporter_Owner_Email

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

DisableDNS

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

FlushEachDataChanges

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

HostingMode

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.

LicenseCatalog

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

LogToConsole

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

LogToFile

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

LogFilesLocation

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

LogToSysLog

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

MailEnable

Enable/disable mail features in vKernel.

MaxConnectionTimeout

NOTE: Added in v4.0

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

MaxIdleClientTimeout

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. :-)

MaxTransferTimeout

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

Port

Specifies the non-secure port, which the vserver will listen. 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.

Port_HTTP

Specifies the HTTP port, which the Server will listen for HTTP protocol. Set it ZERO if no need in this feature.

Port_REST

Specifies the port, which the Server will listen for REST connections. Set it ZERO if no need in this feature.

Port_REST_SSL

Specifies the SSL port, which the Server will listen for REST connections. Set it to ZERO if no need in this feature.

Port_SSL

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 no need in this feature.

Port_SNMP

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

  • VServer Office - 15161
  • VServer Embedded - 15162

Set it ZERO if no need in this feature.

Port_SQLite

Specifies the port, which the Server will listen for SQLite connections. Set it ZERO if no need in this feature.

Port_SQLite_SSL

Specifies the SSL port, which the Server will listen for SQLite connections. Set it to ZERO if no need in this feature.

PrivilegesEnable

Specifies need to check the user privileges.

REST_SSL_Certificate

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

ScheduleEnable

Specifies whether scheduler must be running or not. The default state is ON. 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 master database of VServer and start play when and if you will set this option ON.

[read more ...]

SingleConnectionPerLogin

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

SQLiteSystemCatalog

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

SSL_Certificate

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

SSL_PrivateKey

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

SystemCatalog

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

SystemProjectCatalog

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

SystemBackupCatalog

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

Threads

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

UseOldPasswords

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

VerboseLevel

Specifies how many information VServer will print into log/console. The following are values that you can use in the order of growing 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.