Root definitions

Settings for the web interface

Properties

caching

anyOf [CacheOptions, string]

Caching provider to use for session and invite data

If none is provided the top-level caching provider is used

clients

Array<BotConnection>

A list of CM Servers this Client should connect to.

If not specified a default BotConnection for this instance is generated

credentials

WebCredentials

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.

databaseConfig

databaseConfig

Database backend to use for persistent WEB data

If none is provided the top-level database provider is used

logLevel

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

maxLogs

number

Maximum number of log statements to keep in memory for each subreddit

Default: 200
operators

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"]

port

number

The port for the web interface

  • ENV => PORT
  • ARG => --port <number>
Default: 8085
session

session

Settings to configure the behavior of user sessions -- the session is what the web interface uses to identify logged in users.

storage

string

Storage provider type to use for sessions and other web client specific data

Defaults to database if none is provided

  • Specify database to use top-level database
  • Specify cache to use top-level cache

NOTE: database should almost always be used. Cache would only be necessary if this instance experiences heavy traffic

Valid values: cache, database

Loading...

Editor and Validator