Backend Configuration
The backend server is configured via a YAML file (default mzchat-backend.yml) or environment variables. Environment variables take precedence over the configuration file.
Configuration Options
Section titled “Configuration Options”The port the server listens on (default: 50051)
Type: number
staticPath
Section titled “staticPath”Path to static files to serve (optional)
Type: string | undefined (Optional)
basePath
Section titled “basePath”Base path for the API (default: /mzchat)
Type: string
databaseUrl
Section titled “databaseUrl”Database connection URL (e.g. file:backend.db)
Type: string
databaseBackend
Section titled “databaseBackend”Database backend type (default: sqlite)
Type: "sqlite" | "postgres" | "libsql"
canonicalAddress
Section titled “canonicalAddress”The canonical public address of the server
Type: string
assetsDomain
Section titled “assetsDomain”Domain used for serving assets
Type: string
migrationsPath
Section titled “migrationsPath”Path to database migrations
Type: string
uploadsPath
Section titled “uploadsPath”Path to store uploaded files
Type: string
stateDir
Section titled “stateDir”Directory for storing state (database, secrets, etc.)
Type: string
meiliUrl
Section titled “meiliUrl”Meilisearch URL (optional)
Type: string | undefined (Optional)
meiliApiKey
Section titled “meiliApiKey”Meilisearch API Key (optional)
Type: string | undefined (Optional)
meiliIndexName
Section titled “meiliIndexName”Meilisearch index name (default: mzchat-messages)
Type: string
meiliDbPath
Section titled “meiliDbPath”Path to embedded Meilisearch database
Type: string
jwtSecret
Section titled “jwtSecret”Secret used for signing JWTs
Type: string
logLevel
Section titled “logLevel”Logging level (info, debug, error, etc.)
Type: string
runMigrations
Section titled “runMigrations”Whether to run database migrations on startup
Type: boolean
IRC Server Configuration
Type: Object
enabled(boolean): Enable the IRC serverport(number): Port for the IRC serverpublicHost(string | undefined): Public facing host for the IRC server (optional)publicPort(number | undefined): Public facing port for the IRC server (optional)
livekit
Section titled “livekit”LiveKit Configuration
Type: Object
url(string): LiveKit server URLapiKey(string): LiveKit API KeyapiSecret(string): LiveKit API Secret