Home › Settings Reference
Settings Reference
Every option on the module Settings page, with its default.
| Setting | Default | Description |
|---|
| Staff Chat widget | On | Master switch. Off hides the widget and stops polling. |
| Widget position | Bottom right | Bottom right or bottom left. |
| Accent colour | #00A859 | Header, send button, bubbles and the active room. |
| Show online admin list | On | Hides the right-side “Chat with” list. |
| Show message timestamps | On | Hides the time beside each message. |
| Auto-open on message | Off | Expands the widget when a new message arrives. |
| Unread count in title | On | Shows the unread count and an @ marker in the browser title. |
| Chat box on first load | Expanded | Initial expanded or minimized state for new admins. |
Notifications
| Setting | Default | Description |
|---|
| Default notification sound | Pip | Sound used by admins who have not saved a choice. |
| Sound default | On | Whether new admins hear sounds. |
| Sound volume | 60% | 0 to 100 percent. |
| Desktop notifications | Off | Initial browser notification preference. |
Messages and history
| Setting | Default | Description |
|---|
| Polling interval | 5 seconds | 1 to 60 seconds. Lower is faster but increases server load. |
| Private chat | On | Enables 1:1 rooms. |
| Maximum message length | 2,000 | 1 to 10,000 characters. |
| Messages per load | 100 | Initial widget and history load, 1 to 500. |
| Chat history retention | 90 days | 0 keeps forever. Applied by cron and when history is opened. |
| Maximum messages per room | 100 | Oldest messages are trimmed beyond this cap (1 to 5,000). |
| Live-only mode | Off | Disables History and wipes stored history daily. |
| Typing indicator | On | Shows when another admin is typing. |
| Edit window | 5 minutes | How long an admin can edit their own message. 0 disables editing. |
| Attachments | On | JPG, PNG, GIF, WebP, PDF, TXT and ZIP. |
| Maximum attachment size | 5 MB | 1 to 50 MB, also bounded by PHP upload limits. |
| Total attachment quota | 1,024 MB | Maximum encrypted storage used by all attachments. 0 = unlimited. |
| Link previews | On | Text-only title and description cards. |
Access and safety
| Setting | Default | Description |
|---|
| Ghost mode | None | Selected admins stay in chat but disappear from presence and their names are masked. |
| Read-only roles | None | Roles that can view and react but cannot send. |
| Rate limit | 30 per minute | Per-admin send limit. 0 disables the limit. |
| Blocked words | None | Messages containing a blocked word are rejected server-side. |
| Allow links | On | Off rejects messages that contain a URL. |
Activity log
| Setting | Default | Description |
|---|
| Activity log retention | 90 days | 0 keeps entries until the 1,000-row cap is reached. |
| Log IP addresses | On | Off stores blank IP values. |
Reset
Reset settings to defaults restores every option above. It is Full Administrator-only and CSRF-protected, and the change is written to the activity log.
Saving
Settings save over AJAX and show a toast on success, so you do not lose your place. A validation error is reported next to the field and nothing is written until the value is valid.