Help Center

Configuration file in detail


Configuration file “sync-it-server.conf” is stored in different locations depending on OS:
- Windows: C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\sync-it-server\sync-it-server.conf
- Linux: ${sync_it_server_dir}/sync-it-server.conf
It has JSON syntax, so please stick to JSON syntax to ensure Management Server can parse the file succesfully.

Every time you change the file you’ll need to restart the Management Server for changes to take effect.

“events_server” section

Event logger logs all the file operations done by Sync on all clients.

Field

Default value

Purpose

maxFiles

40

Maximum amount of files stored by event logger

protocol

https

Protocol used by clients to connect to event server

maxsize

4194240000

Maximum file size. When exceeded, event logger will create a new file, up to maxFiles

filename

/data/events.log

Name of currently used log

host

0.0.0.0

Interface used by event logger for incoming connections. 0.0.0.0 means logger is listening on all avalilable interfaces.

port

8445

Port used by event logger for incoming connections



“peerServer” section

peerServer section contains settings used by clients to connect, report status and receive a new set of settings from the Management Server.

Field

Default value

Purpose

tls

{"cert": "certs/peer.crt",

"key": "certs/peer.key"},

Path to server certificate and private key, used for establishing SSL connection.

host

0.0.0.0

Interface used by Management Server for incoming connections. 0.0.0.0 means server is listening on all avalilable interfaces.

port

8444

Port used by Management Server for incoming connections

“https” section

https section contains settings used by admin to connect to the Management Server WebUI.

Field

Default value

Purpose

ssl

{"cert": "certs/web.crt",

"key": "certs/web.key"},

Path to server certificate and private key, used for accessing WebUI over SSL

host

0.0.0.0

Interface used by WebUI for incoming connections. 0.0.0.0 means server is listening on all avalilable interfaces.

port

8443

Port used by WebUI for incoming connections



“backup” section

backup section contains settings on backing up all server data as well as cleanup schedule.

Field

Default value

Purpose

ttl

30

Time in days for storing backups

cleanup

0 0 6 * * *

Schedule to clean up old backups

schedule

0 0 6 * * *

Schedule to perform backups

The "0 0 6 * * *" is a way to schedule task very similar to the one in crontab with the only difference that values are "seconds minutes hours days weeks months". So the "0 0 6 * * *" indicates to make a daily backup at 6am.

Other sections and sectionless params

winston section is used for Management Server and database logs. It is advised not to change default values.

logs-storage value contains relative path to the store debug logs, collected by server from Sync clients.

db section contains path to the Management Server database.

system section contains path to file, where Management Server records its PID when started.