CONFIG.md

Syncmatica Configuration Manual

This document explains what the possibilities, options and restrictions of configuring syncmatica are.

Configuration

syncmatica is configured by a config.json which can be found in config/syncmatica/config.json. The json inside configures several settings on the Server/Client which are grouped together into categories. Here is an example of the current (As of this files last update time current) config.json:

Server config.json

{
	"quota": {
		"enabled": false,
		"limit": 40000000
	},
	"debug": {
		"doPackageLogging": false
	}
}

Client config.json

{
	"debug": {
		"doPackageLogging": false
	}
}

If the file is missing or otherwise cannot be read, the file might completely reset itself during startup. If parts of the configuration are damaged/unreadable, the file will try to reset the portions during startup. Extra entries are ignored.

Quota

The key "quota" configures the quota feature of the server.

• enabled defines whether the quota feature is enabled on the server. The feature blocks uploads from clients if the client exceeds a limit for file uploads. How much the client already uploaded resets itself when the server shuts down. Can be true or false
• limit defines the limit that a client is able to upload in bytes.

Debug

The key "debug" configures the debug feature of the mod.

• doPackageLogging configures whether the client/server should add a debug log for all outgoing and incoming packets. The type of the packet and the target of the packet gets logged for outgoing packets - for incoming only the type of the packet gets logged.