example.config.jsonc

{
	// What port should the API listen on?
	// Default: 8080
	"port": 8080,

	// Taken directly from Photon PUN 2 configuration.
	"photon": {
		// Set this using the value found in your Photon dashboard.
		"AppIdRealtime": "<YOUR-PHOTON-REALTIME-APP-ID>",
		// Can be left blank.
		"AppIdFusion": "",
		// Can be left blank.
		"AppIdChat": "",
		// Set this using the value found in your Photon dashboard.
		"AppIdVoice": "YOUR-PHOTON-VOICE-APP-ID",
		// Set this to the version of CVR you use on your server.
		"AppVersion": "2.2.0",
		// Leave as-is.
		"UseNameServer": true,
		// Leave as-is.
		"FixedRegion": "eu",
		// Leave as-is.
		"Server": "",
		// Leave as-is.
		"Port": 0,
		// Leave as-is.
		"ProxyServer": "",
		// Leave as-is.
		"Protocol": 0,
		// Leave as-is.
		"EnableProtocolFallback": true,
		// Leave as-is.
		"AuthMode": 0,
		// Leave as-is.
		"EnableLobbyStatistics": false,
		// Leave as-is.
		"NetworkLogging": 1,
		// Leave as-is.
		"IsMasterServerAddress": false,
		// Leave as-is.
		"IsBestRegion": false,
		// Leave as-is.
		"IsDefaultNameServer": true,
		// Leave as-is.
		"IsDefaultPort": true
	},

	// Configuration for the database used by the API.
	// Right now, only MongoDB is supported. Sorry.
	"database": {
		// The URL used to connect to the MongoDB instance.
		"mongodb_connection_string": "mongodb+srv://YOUR-CONNECTION-STRING-HERE",
		// The database in MongoDB that should be used.
		"mongodb_database_name": "YOUR-DATABASE-NAME"
	},

	// Configuration for blob storage (S3-compatible)
	"blob": {
		// The S3-compatible endpoint URL that should be used.
		"s3_endpoint_url": "https://YOUR-S3-ENDPOINT-HERE",
		// The access key ID that should be used with the S3-compatible API.
		"s3_access_key_id":"YOUR-S3-ACCESS-KEY-ID-HERE",
		// The secret access key that should be used with the S3-compatible API.
		"s3_secret_access_key": "YOUR-S3-SECRET-ACCESS-KEY-HERE"
	},

	// All options relating to the image / photo system.
	"images": {
		// Completely disables image fetching, will return an error status.
		// Default: false
		"disable_fetch": false,
		// Disables the in-memory cache. Useful on memory-constrained systems.
		// Default: false
		"disable_caching": false,
		// Prevents users from uploading images entirely.
		// Default: false
		"disable_upload": false,

		// The maximum size of uploaded images.
		// Default: "10mb"
		"max_size": "10mb",

		// The maximum number of images a given player can upload in an *hour*.
		"upload_rate_limit": 60,
		// The maximum number of images a given player can upload in a *minute*.
		"fetch_rate_limit": 120,

		// The S3(-compatible) bucket that should be used for storing images.
		"s3_bucket": "MyCVRImageBucket",
		// The domain that can be used to access the bucket.
		"domain": "https://YOUR-PUBLIC-IMAGE-BUCKET-DOMAIN-HERE"
	},

	// Configuration relating to custom rooms.
	"rooms": {
		// The S3(-compatible) bucket that should be used for storing rooms.
		"s3_bucket": "MyCVRRoomBucket",
		// The domain that can be used to access the bucket.
		"domain": "https://YOUR-PUBLIC-ROOM-BUCKET-DOMAIN-HERE"
	},

	// Settings for debugging / developing the API itself.
	"debug": {
		// Logs the level of server load to the audit log very frequently.
		// Default: false
		"enable_load_logging": false,
		// Prints a tabulated display of all live matchmaking instances
		// every few minutes.
		// Default: false
		"trace_instances": false,
		
		// The identifier for this specific CVR server instance, used in the
		// Discord webhook on audit logs. Leave blank, and the webhook won't
		// be invoked.
		"discord_webhook_id": "My CVR Server :)",
		// The URL that should be called to send a Discord webhook. Leave blank
		// to prevent the webhook from being called.
		"discord_webhook_url": "https://discord.com/YOUR-WEBHOOK-URL-HERE",

		// The secret that should be used to verify Git webhooks.
		"webhook_git_pull_secret": "YOUR-GIT-PULL-SECRET",

		// The path that should be used for your log file.
		// Default: ./data/cvr.log
		"audit_log_path": "./data/cvr.log",

		// Sets the level of logging to be used on every request.
		// Default: 1.
		// Possible values:
		// 0: None
		// 1: HTTP method and URL
		"request_trace_level": 1
	},

	// Used to configure the Automatic Error Reporting (AER) system.
	"error_reporting": {
		// An absolute or relative path to a public key for encrypting
		// all received error reports.
		"public_key_path": "/PATH/TO/YOUR/KEY.pub",
		// The format of the public key.
		"public_key_format": "openssh-public"
	},

	// Settings related to in-game moderation.
	"moderation": {
		// After how many reports should we automatically time out a player?
		// Default: 3
		"timeout_after_reports": 3
	},

	// Config related to the authentication process (login, 2FA, etc)
	"authentication": {
		// The secret used to sign all JWTs.
		"token_secret": "YOUR-TOKEN-SIGNING-SECRET-HERE"
	}
}