Admin Settings Reference
This page documents all server-level settings available to administrators.
Instance Setup
Access via Admin → Instance Setup.
The setup checklist is the quickest way to understand which features are ready on a self-hosted instance. It shows cards for authentication, email, maps, geocoding, file uploads, downloads, events, and plugins. Each card reports whether the capability is configured and enabled, lists any missing environment variables, and links to the relevant setup documentation.
The checklist reflects capability status reported by the backend; it does not store infrastructure secrets. After changing environment variables, recreate the affected container and return to this page to confirm the new status.
Optional integrations degrade cleanly when they are absent. For example, upload controls and event-location controls are hidden or disabled instead of allowing an operation that will fail.
Server Configuration
Access via Admin Settings → Settings.
Basic Settings
| Setting | Description |
|---|---|
serverName | Internal identifier for the server (must match backend) |
serverDescription | Public description shown on the server homepage |
serverIconURL | URL to server icon/logo image |
rules | Server rules displayed to all users (Markdown supported) |
Feature Toggles
Enable or disable platform features server-wide:
| Setting | Default | Description |
|---|---|---|
enableDownloads | true | Allow downloadable file attachments |
enableEvents | true | Allow event creation |
These settings express an administrator's choice, but a feature may also depend on an instance capability. The Instance Setup page identifies missing configuration.
File Upload Settings
| Setting | Description |
|---|---|
allowedFileTypes | List of allowed file extensions (e.g., .stl, .zip) |
Example allowed file types:
[".stl", ".obj", ".zip", ".rar", ".blend", ".png", ".jpg", ".gif", ".glb"]
Branding
Access via Admin Settings → Settings → Branding.
Controls the documentation, source, issue-tracker and support links in the site footer, the product name in its attribution line, and any extra footer links.
| Setting | Description |
|---|---|
brandingProductName | Name shown in the footer attribution |
brandingDocsURL | Documentation link target |
brandingSourceURL | Source repository link target |
brandingIssuesURL | Issue tracker for the software itself |
brandingSupportEmail | Support contact address for this instance |
brandingShowUpstreamLinks | Hide every upstream reference in one setting |
brandingCustomFooterLinks | Up to eight extra footer links |
Blanking a field hides that link. A deployment can also set these values as environment variables, and can pin them so this tab becomes read-only. See Instance branding for resolution order, accepted values, and the environment variables.
Plugin Configuration
| Setting | Description |
|---|---|
pluginRegistries | URLs to plugin registry endpoints |
pluginPipelines | Pipeline configuration for plugin execution |
Default Roles
Access via Admin Settings → Roles.
DefaultServerRole
Baseline permissions for all authenticated users:
| Permission | Description |
|---|---|
canCreateChannel | Create new channels/forums |
canCreateDiscussion | Post new discussions |
canCreateEvent | Create events |
canCreateComment | Comment on content |
canUpvoteDiscussion | Upvote discussions |
canUpvoteComment | Upvote comments |
canUploadFile | Upload files and images |
canGiveFeedback | Give feedback comments |
showAdminTag | Display admin badge (deprecated) |
DefaultModRole
Baseline permissions for all moderators:
| Permission | Description |
|---|---|
canReport | Report content for review |
canGiveFeedback | Give feedback to content authors |
canHideComment | Archive comments |
canHideDiscussion | Archive discussions |
canHideEvent | Archive events |
canEditComments | Edit others' comments |
canEditDiscussions | Edit others' discussions |
canEditEvents | Edit others' events |
canSuspendUser | Suspend users |
canLockChannel | Lock channels |
canOpenSupportTickets | Open support issues |
canCloseSupportTickets | Close support issues |
canArchiveImage | Archive images |
canPermanentlyRemoveImage | Permanently delete images |
canDeleteWiki | Delete wiki pages |
DefaultElevatedModRole
Enhanced permissions for explicitly added moderators:
All permissions from DefaultModRole, plus:
| Permission | Description |
|---|---|
canAddMods | Add new moderators |
canRemoveMods | Remove moderators |
canAddOwners | Add channel owners |
canRemoveOwners | Remove channel owners |
canChangeSettings | Modify channel settings |
canEditWiki | Edit wiki pages |
DefaultSuspendedRole
Restricted permissions for suspended users:
Most permissions are false. Suspended users can typically only:
- View content
- See their suspension reason
DefaultSuspendedModRole
Restricted permissions for suspended moderators:
Similar to DefaultSuspendedRole but for moderator actions.
Server Membership
Managing Server Admins
Admins have full access to server settings and can:
- Access all admin panel sections
- Manage other admins and moderators
- Configure server-wide settings
- Access all channels regardless of permissions
To invite an admin:
- Go to Admin Settings → Settings
- Find Server Admins section
- Click Invite Admin
- Enter the username
- User must accept the invitation
To remove an admin:
- Find the admin in the list
- Click the remove button
- Confirm removal
Managing Server Moderators
Server moderators have server-wide moderation capabilities:
- Access to server-level issues
- Can moderate across all channels
- Use DefaultModRole or ElevatedModRole permissions
To invite a moderator:
- Go to Admin Settings → Settings
- Find Server Moderators section
- Click Invite Moderator
- Enter the username
- User must accept the invitation
Suspension Management
Server-Level User Suspensions
Access via Admin Settings → Suspended Users.
Server-level suspensions affect users across all channels:
- User cannot create content anywhere
- User cannot create new channels
- Suspension displays on all attempts
Each suspension record shows:
- Username
- Suspension date
- Expiration (if time-limited)
- Related moderation issue
To unsuspend:
- Find the user in the suspended list
- Click Unsuspend
- Confirm action
Server-Level Mod Suspensions
Access via Admin Settings → Suspended Mods.
Suspended moderators cannot perform moderation actions server-wide.
Issues Management
Access via Admin Settings → Issues.
View and manage moderation issues across all channels:
Issue Properties
| Property | Description |
|---|---|
issueNumber | Unique issue identifier |
title | Issue title |
body | Issue description |
isOpen | Whether issue is still open |
channelUniqueName | Related channel (if any) |
relatedDiscussionId | Related discussion (if any) |
relatedCommentId | Related comment (if any) |
relatedEventId | Related event (if any) |
relatedUsername | Related user (if any) |
flaggedServerRuleViolation | Whether it's a server rule violation |
Issue Types
Issues can relate to:
- Reported discussions
- Reported comments
- Reported events
- Reported wiki edits
- Reported images
- Reported channels
- User suspensions
Plugin Management
Access via Admin Settings → Plugins.
Installing Plugins
- Add plugin registry URLs to
pluginRegistries - Click Refresh Plugins to fetch available plugins
- Select a plugin version to install
- Configure any required secrets
Plugin Secrets
Some plugins require API keys or secrets:
- Go to the plugin configuration
- Click Set Secret
- Enter the secret value
- Secrets are encrypted at rest
Plugin Pipelines
Configure when plugins execute. Plugins never run merely because they are enabled; each event requires an explicit ordered pipeline.
pipelines:
- event: downloadableFile.created
applicability: NEW_FILES_ONLY
steps:
- plugin: security-attachment-scan
condition: ALWAYS
See Plugin pipelines for server and channel scope, existing-file rollout policies, quarantine review, retries, and monitoring. See Security attachment scanning for the first-party scanner service and Declarative plugin configuration for plan/apply automation.
Image Reports
Access via Admin Settings → Image Reports.
Review reported images and take action:
Actions
| Action | Description |
|---|---|
| Archive | Hide image from public view |
| Permanently Remove | Delete image and storage file |
| Mark Clean | Clear any flags |
Scan Status
| Status | Description |
|---|---|
PENDING | Awaiting scan |
CLEAN | No issues found |
INFECTED | Malware detected |
SUSPICIOUS | Flagged for manual review |
FAILED | Scan error |
Channel Reports
Access via Admin Settings → Channel Reports.
View reports specific to channels:
- Filter by channel
- See all issues for a channel
- Monitor channel-specific problems
Best Practices
Role Configuration
- Start with restrictive defaults
- Grant elevated permissions sparingly
- Review permissions regularly
- Use channel-specific overrides for exceptions
Suspension Management
- Always link suspensions to issues
- Use time-limited suspensions when appropriate
- Document suspension reasons clearly
- Review expired suspensions periodically
Plugin Security
- Only install plugins from trusted sources
- Review plugin code when possible
- Use plugin secrets for sensitive data
- Monitor plugin execution logs