Settings for the web interface
anyOf [CacheOptions, string]
Caching provider to use for session and invite data
If none is provided the top-level caching provider is used
Array<BotConnection>
A list of CM Servers this Client should connect to.
If not specified a default BotConnection
for this instance is generated
Separate credentials for the web interface can be provided when also running the api.
All properties not specified will default to values given in ENV/ARG credential properties
Refer to the required credentials table to see what is necessary for the web interface.
Database backend to use for persistent WEB data
If none is provided the top-level database provider is used
string
The default log level to filter to in the web interface
If not specified or null
will be same as global logLevel
Valid values: debug
, error
, info
, verbose
, warn
number
Maximum number of log statements to keep in memory for each subreddit
200
Array<string>
The name, or names, of the Reddit accounts, without prefix, that the operators of this web interface uses.
Note: This is not the same as the top-level operator
property. This allows specified users to see the status of all clients
but not access to them -- that must still be specified in the operator.name
property in the configuration of each bot.
EX -- User is /u/FoxxMD then "name": ["FoxxMD"]
number
The port for the web interface
PORT
--port <number>
8085
Settings to configure the behavior of user sessions -- the session is what the web interface uses to identify logged in users.
string
Storage provider type to use for sessions and other web client specific data
Defaults to database
if none is provided
database
to use top-level databasecache
to use top-level cacheNOTE: database
should almost always be used. Cache would only be necessary if this instance experiences heavy traffic
Valid values: cache
, database