Server Configuration Reference
This page documents all ServerConfig fields and environment variables for running a Multiforum instance.
ServerConfig Fields
The ServerConfig type in the database stores server-wide settings.
| Field | Type | Description |
|---|
serverName | String! | Unique identifier for the server (must match VITE_SERVER_NAME) |
serverDescription | String | Public description shown on the homepage |
serverIconURL | String | URL to server icon/logo image |
rules | JSON | Server-wide rules (Markdown supported) |
Feature Toggles
| Field | Type | Default | Description |
|---|
enableDownloads | Boolean | true | Allow downloadable file attachments |
enableEvents | Boolean | true | Allow event creation |
File Settings
| Field | Type | Description |
|---|
allowedFileTypes | [String] | List of allowed file extensions (e.g., [".stl", ".zip"]) |
Plugin Settings
| Field | Type | Description |
|---|
pluginRegistries | [String] | URLs to plugin registry endpoints |
pluginPipelines | JSON | Pipeline configuration for plugin execution |
Relationships
| Relationship | Target | Description |
|---|
Admins | [User] | Server administrators |
Moderators | [ModerationProfile] | Server-level moderators |
PendingAdminInvites | [User] | Pending admin invitations |
PendingModInvites | [User] | Pending moderator invitations |
SuspendedUsers | [Suspension] | Server-level suspended users |
SuspendedMods | [Suspension] | Server-level suspended moderators |
AllowedPlugins | [Plugin] | Allowed plugins |
InstalledVersions | [PluginVersion] | Installed plugin versions |
Role Relationships
| Relationship | Target | Description |
|---|
DefaultServerRole | ServerRole | Default permissions for all users |
DefaultModRole | ModServerRole | Default moderator permissions |
DefaultElevatedModRole | ModServerRole | Elevated moderator permissions |
DefaultSuspendedRole | ServerRole | Permissions for suspended users |
DefaultSuspendedModRole | ModServerRole | Permissions for suspended moderators |
Backend Environment Variables
Required