"text": "Configuration\n\n\nInEngine Settings\n\n\nConfiguration is accomplished by modifying the appsettings.json file that comes with the InEngine.NET binary distribution.\nThe \n-c, --configuration\n argument can also be used to specify an alternate configuration file.\n\n\n{\n\n \nInEngine\n:\n \n{\n\n \nPlugins\n:\n \n{\n\n \nMyPlugin\n:\n \n/path/to/plugin/assembly\n\n \n},\n\n \nExecWhitelist\n:\n \n{\n\n \nfoo\n:\n \n/path/to/foo.exe\n\n \n},\n\n \nMail\n:\n \n{\n\n \nHost\n:\n \nlocalhost\n,\n\n \nPort\n:\n \n25\n,\n\n \nFrom\n:\n \
[email protected]\n\n \n},\n\n \nQueue\n:\n \n{\n\n \nUseCompression\n:\n \nfalse\n,\n\n \nPrimaryQueueConsumers\n:\n \n4\n,\n\n \nSecondaryQueueConsumers\n:\n \n2\n,\n\n \nQueueDriver\n:\n \nrabbitmq\n,\n\n \nQueueName\n:\n \nInEngineQueue\n,\n\n \nRedis\n:\n \n{\n\n \nHost\n:\n \n127.0.0.1\n,\n\n \nPort\n:\n \n6379\n,\n\n \nDatabase\n:\n \n0\n,\n\n \nPassword\n:\n \n\n \n},\n\n \nRabbitMQ\n:\n \n{\n\n \nHost\n:\n \nlocalhost\n,\n\n \nPort\n:\n \n5672\n,\n\n \nUsername\n:\n \n,\n\n \nPassword\n:\n \n\n \n},\n\n \nFile\n:\n \n{\n\n \nBasePath\n:\n \n../\n\n \n}\n\n \n}\n\n \n}\n\n\n}\n\n\n\n\n\n\nTop-level Settings\n\n\n\n\n\n\n\n\nSetting\n\n\nType\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nPlugins\n\n\nobject\n\n\nA set of key/value pairs, where the value is the directory where the plugin is located and the key is the plugin name sans .dll extension.\n\n\n\n\n\n\nExecWhitelist\n\n\nobject\n\n\nA set of key/value pairs, where the value is the file system path of an executable and the key is a command alias.\n\n\n\n\n\n\n\n\nMail Settings\n\n\n\n\n\n\n\n\nSetting\n\n\nType\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nHost\n\n\nstring\n\n\nThe hostname of an SMTP server.\n\n\n\n\n\n\nPort\n\n\ninteger\n\n\nThe port of an SMTP server.\n\n\n\n\n\n\nFrom\n\n\nstring\n\n\nThe default email address used to send email from.\n\n\n\n\n\n\n\n\nQueue Settings\n\n\nGeneral Settings\n\n\n\n\n\n\n\n\nSetting\n\n\nType\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nUseCompression\n\n\nbool\n\n\nA situation performance optimization that compresses queued messages.\n\n\n\n\n\n\nPrimaryQueueConsumers\n\n\nstring\n\n\nThe number of consumers to schedule for the secondary queue.\n\n\n\n\n\n\nSecondaryQueueConsumers\n\n\nstring\n\n\nThe number of consumers to schedule for the secondary queue.\n\n\n\n\n\n\nQueueDriver\n\n\nstring\n\n\nThe driver to use to interact with a queue data store.\n\n\n\n\n\n\nQueueName\n\n\nstring\n\n\nThe base name of the queue, used to form the Redis Queue keys.\n\n\n\n\n\n\n\n\nRabbitMQ Client-specific Settings\n\n\n\n\n\n\n\n\nSetting\n\n\nType\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nHost\n\n\nstring\n\n\nThe RabbitMQ hostname to connect to.\n\n\n\n\n\n\nPort\n\n\ninteger\n\n\nRabbitMQ's port.\n\n\n\n\n\n\nUsername\n\n\nstring\n\n\nThe RabbitMQ username to authenticate with.\n\n\n\n\n\n\nPassword\n\n\nstring\n\n\nThe RabbitMQ password to authenticate with.\n\n\n\n\n\n\n\n\nRedis Client-specific Settings\n\n\n\n\n\n\n\n\nSetting\n\n\nType\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nHost\n\n\nstring\n\n\nThe Redis hostname to connect to.\n\n\n\n\n\n\nPort\n\n\ninteger\n\n\nRedis's port.\n\n\n\n\n\n\nDatabase\n\n\ninteger\n\n\nThe Redis database - 0-15.\n\n\n\n\n\n\nPassword\n\n\nstring\n\n\nThe Redis auth password.\n\n\n\n\n\n\n\n\nFile Client-specific Settings\n\n\n\n\n\n\n\n\nSetting\n\n\nType\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nBasePath\n\n\nstring\n\n\nThe file system path where the queue directories should be located.\n\n\n\n\n\n\n\n\nLogging Settings\n\n\nAny exceptions thrown by a command will be logged, provided NLog is configured to log exceptions. \nThe \nNLog configuration\n file needs to be setup with something like this: \n\n\n?xml version=\n1.0\n encoding=\nutf-8\n ?\n\n\nnlog\n \nxmlns=\nhttp://www.nlog-project.org/schemas/NLog.xsd\n\n \nxmlns:xsi=\nhttp://www.w3.org/2001/XMLSchema-instance\n\n\n \ntargets\n\n \ntarget\n \nname=\nlogfile\n \nxsi:type=\nFile\n \nfileName=\ninengine.log\n \n/\n\n \n/targets\n\n\n \nrules\n\n \nlogger\n \nname=\n*\n \nminlevel=\nError\n \nwriteTo=\nlogfile\n \n/\n\n \n/rules\n\n\n/nlog\n\n\n\n\n\n\nInEngine.Core does not depend explicitly on NLog, but rather \nCommon.Logging\n.\nThis means that any logging framework that Common.Logging supports can be used.\nConfiguring Common.Logging to use a different logging framework is out of the scope of this documentation.",
0 commit comments