Configuration

After running the installer, the configuration file is published to config/chatify.php. This page documents every key.

General

Key	Default	Description
`name`	`Chatify Messenger`	Application name shown in the UI. Env: `CHATIFY_NAME`
`storage_disk_name`	`public`	Laravel filesystem disk for attachments and avatars. Env: `CHATIFY_STORAGE_DISK`

Models

Override the default Eloquent model classes if you need to extend them:

'models' => [
    'user'         => App\Models\User::class,
    'conversation' => Chatify\Models\Conversation::class,
    'message'      => Chatify\Models\Message::class,
    'participant'  => Chatify\Models\ConversationParticipant::class,
    'favorite'     => Chatify\Models\Favorite::class,
    'block'        => Chatify\Models\UserBlock::class,
    'user_setting' => Chatify\Models\UserSetting::class,
],

To use a custom model, create a class that extends the Chatify model and update the config:

'models' => [
    'message' => App\Models\ChatMessage::class,
],

Tables

Override table names if they conflict with your existing schema:

'tables' => [
    'conversations' => 'ch_conversations',
    'participants'  => 'ch_conversation_participants',
    'messages'      => 'ch_messages',
    'favorites'     => 'ch_favorites',
    'blocks'        => 'ch_user_blocks',
    'user_settings' => 'ch_user_settings',
],

API

'api' => [
    'prefix'       => env('CHATIFY_API_PREFIX', 'api/chatify/v1'),
    'middleware'    => [...], // resolved from CHATIFY_API_MIDDLEWARE
    'expose_email' => env('CHATIFY_EXPOSE_EMAIL', false),
],

Key	Default	Description
`api.prefix`	`api/chatify/v1`	URL prefix for all API routes
`api.middleware`	`web,auth` or `api,auth:sanctum`	Middleware stack. Resolved from `CHATIFY_API_MIDDLEWARE` env var. Defaults to `web,auth` when web is enabled, `api,auth:sanctum` otherwise.
`api.expose_email`	`false`	Whether to include user email addresses in API responses

Web (bundled UI)

'web' => [
    'enabled'    => env('CHATIFY_WEB_ENABLED', true),
    'prefix'     => env('CHATIFY_ROUTES_PREFIX', 'chatify'),
    'middleware' => ['web', 'auth'],
    'layout'     => env('CHATIFY_WEB_LAYOUT', 'Chatify::layouts.app'),
],

Key	Default	Description
`web.enabled`	`true`	Load the web routes (`/chatify`). Set to `false` for API-only mode.
`web.prefix`	`chatify`	URL prefix for the messenger page
`web.middleware`	`['web', 'auth']`	Middleware for web routes
`web.layout`	`Chatify::layouts.app`	Blade layout template

User avatar

'user_avatar' => [
    'folder'  => 'users-avatar',
    'default' => 'avatar.png',
],

Key	Default	Description
`user_avatar.folder`	`users-avatar`	Storage folder for user avatars
`user_avatar.default`	`avatar.png`	Default avatar filename

Gravatar

'gravatar' => [
    'enabled'    => true,
    'image_size' => 200,
    'imageset'   => 'identicon',
],

Key	Default	Description
`gravatar.enabled`	`true`	Use Gravatar for users without a custom avatar
`gravatar.image_size`	`200`	Gravatar image size in pixels
`gravatar.imageset`	`identicon`	Gravatar default image style (`identicon`, `monsterid`, `wavatar`, etc.)

Attachments

'attachments' => [
    'folder'          => 'attachments',
    'allowed_images'  => ['png', 'jpg', 'jpeg', 'gif'],
    'allowed_files'   => ['zip', 'rar', 'txt', 'webm', 'ogg', 'mp4', ...],
    'max_upload_size' => env('CHATIFY_MAX_FILE_SIZE', 150),
],

Key	Default	Description
`attachments.folder`	`attachments`	Storage folder for attachments
`attachments.allowed_images`	`['png', 'jpg', 'jpeg', 'gif']`	Allowed image extensions
`attachments.allowed_files`	See config file	Allowed non-image file extensions
`attachments.max_upload_size`	`150`	Maximum upload size in MB. Env: `CHATIFY_MAX_FILE_SIZE`

Giphy

'giphy' => [
    'enabled' => env('CHATIFY_GIPHY_ENABLED', true),
    'api_key' => env('CHATIFY_GIPHY_API_KEY'),
],

Key	Default	Description
`giphy.enabled`	`true`	Enable the Giphy sticker picker
`giphy.api_key`	`null`	Your Giphy API key. Get one at developers.giphy.com

Colors

'colors' => [
    'enabled' => env('CHATIFY_COLORS_ENABLED', true),
    'list'    => ['#2180f3', '#2196F3', '#00BCD4', ...],
],

Key	Default	Description
`colors.enabled`	`true`	Let users pick a chat accent color
`colors.list`	10 hex colors	Available color options

Themes

'themes' => [
    'enabled' => env('CHATIFY_THEMES_ENABLED', true),
    'list'    => ['classic', 'day', 'tinted', 'night'],
],

Key	Default	Description
`themes.enabled`	`true`	Let users switch themes
`themes.list`	`['classic', 'day', 'tinted', 'night']`	Available theme names

Fonts

'fonts' => [
    'enabled' => env('CHATIFY_FONTS_ENABLED', true),
    'list'    => ['system', 'segoe', 'arial', 'helvetica', ...],
],

Key	Default	Description
`fonts.enabled`	`true`	Let users choose a chat font
`fonts.list`	17 font names	Available font options

Chat background (wallpaper)

'chat_background' => [
    'enabled'      => env('CHATIFY_WALLPAPER_ENABLED', true),
    'folder'       => 'chat-backgrounds',
    'patterns_url' => env('CHATIFY_PATTERNS_URL', '/vendor/chatify/patterns'),
    'patterns'     => [
        ['name' => 'Bubbles',   'filename' => 'bubbles.svg'],
        ['name' => 'Circuit',   'filename' => 'circuit-board.svg'],
        ['name' => 'Glamorous', 'filename' => 'glamorous.svg'],
        ['name' => 'Hideout',   'filename' => 'hideout.svg'],
    ],
],

Key	Default	Description
`chat_background.enabled`	`true`	Let users set a chat background
`chat_background.folder`	`chat-backgrounds`	Storage folder for custom backgrounds
`chat_background.patterns_url`	`/vendor/chatify/patterns`	Public URL for built-in SVG patterns
`chat_background.patterns`	4 patterns	Available wallpaper patterns

Group conversations support four roles: owner (full control, one per group), admin (full or scoped permissions), moderator (add/remove members), and member (send messages only). Admins can be scoped with JSON permissions: edit_info, add_members, remove_members, and manage_admins.

Create a group with POST /api/chatify/v1/conversations/group. Upload an avatar with POST /api/chatify/v1/conversations/{conversation}/avatar. Manage participants via GET/POST/PATCH/DELETE on /conversations/{conversation}/participants. The owner can transfer ownership with POST /conversations/{conversation}/transfer-ownership; any participant can leave with POST /conversations/{conversation}/leave.

'groups' => [
    'enabled'                => env('CHATIFY_GROUPS_ENABLED', true),
    'min_participants'       => 2,
    'max_participants'       => env('CHATIFY_GROUP_MAX_PARTICIPANTS', 50),
    'max_name_length'        => 100,
    'max_description_length' => 500,
    'avatar_folder'          => 'groups-avatar',
    'preview_members'        => 6,
],

Key	Default	Description
`groups.enabled`	`true`	Enable or disable group conversations
`groups.min_participants`	`2`	Minimum participants (including creator)
`groups.max_participants`	`50`	Maximum participants per group
`groups.max_name_length`	`100`	Maximum characters for group name
`groups.max_description_length`	`500`	Maximum characters for group description
`groups.avatar_folder`	`groups-avatar`	Storage folder for group avatars
`groups.preview_members`	`6`	Number of members shown in the inbox preview

Sounds

'sounds' => [
    'enabled'          => env('CHATIFY_SOUNDS_ENABLED', true),
    'incoming_message' => [
        'enabled' => env('CHATIFY_SOUND_INCOMING_ENABLED', true),
        'url'     => env('CHATIFY_SOUND_INCOMING', '/vendor/chatify/sounds/incoming.wav'),
    ],
    'outgoing_message' => [
        'enabled' => env('CHATIFY_SOUND_OUTGOING_ENABLED', true),
        'url'     => env('CHATIFY_SOUND_OUTGOING', '/vendor/chatify/sounds/outgoing.wav'),
    ],
    'typing' => [
        'enabled' => env('CHATIFY_SOUND_TYPING_ENABLED', false),
        'url'     => env('CHATIFY_SOUND_TYPING', '/vendor/chatify/sounds/typing.wav'),
    ],
],

Key	Default	Description
`sounds.enabled`	`true`	Master switch for all sound effects
`sounds.incoming_message.enabled`	`true`	Play sound on incoming messages
`sounds.incoming_message.url`	`/vendor/chatify/sounds/incoming.wav`	URL for incoming message sound
`sounds.outgoing_message.enabled`	`true`	Play sound on outgoing messages
`sounds.outgoing_message.url`	`/vendor/chatify/sounds/outgoing.wav`	URL for outgoing message sound
`sounds.typing.enabled`	`false`	Play sound when someone is typing
`sounds.typing.url`	`/vendor/chatify/sounds/typing.wav`	URL for typing sound

Saved messages

Saved Messages is a personal self-chat (Conversation::TYPE_SAVED) auto-created the first time a user opens the messenger. The user is the only participant — use it for bookmarks, notes, links, or file storage. Messages work like regular messages: text, attachments, and forwards from other conversations are all supported.

Saved-messages conversations cannot be hidden or deleted. Clear all messages (keeping the conversation) with:

POST /api/chatify/v1/conversations/{conversation}/clear

'saved_messages' => [
    'enabled' => env('CHATIFY_SAVED_MESSAGES_ENABLED', true),
    'title'   => env('CHATIFY_SAVED_MESSAGES_TITLE', 'Saved Messages'),
],

Key	Default	Description
`saved_messages.enabled`	`true`	Enable or disable saved messages
`saved_messages.title`	`Saved Messages`	Display name shown in the UI

Frontend

'frontend' => [
    'asset_url' => env('CHATIFY_ASSET_URL'),
    'broadcast' => [
        'driver'   => env('CHATIFY_BROADCAST_DRIVER', env('BROADCAST_CONNECTION', 'null')),
        'key'      => env('PUSHER_APP_KEY'),
        'cluster'  => env('PUSHER_APP_CLUSTER', 'mt1'),
        'wsHost'   => env('PUSHER_HOST'),
        'wsPort'   => (int) env('PUSHER_PORT', 443),
        'forceTLS' => env('PUSHER_APP_USETLS', true),
    ],
],

Key	Default	Description
`frontend.asset_url`	`null`	Custom base URL for frontend assets (CDN). When `null`, assets are served from `/vendor/chatify/`.
`frontend.broadcast.*`	From Pusher env vars	Broadcasting connection settings passed to the frontend Echo instance

See Broadcasting for full setup instructions.

Localization

'rtl_locales' => ['ar', 'he', 'fa', 'ur'],

'locale' => [
    'middleware'       => env('CHATIFY_LOCALE_MIDDLEWARE', true),
    'detect_via'       => ['header', 'query', 'user', 'app'],
    'header'           => 'Accept-Language',
    'fallback_header'  => 'X-Chatify-Locale',
    'query_parameter'  => 'locale',
    'user_attribute'   => 'locale',
],

See Localization for details.

Feature toggles summary

Quick reference for all boolean toggles:

Feature	Config key	Env var	Default
Web UI	`web.enabled`	`CHATIFY_WEB_ENABLED`	`true`
Groups	`groups.enabled`	`CHATIFY_GROUPS_ENABLED`	`true`
Saved messages	`saved_messages.enabled`	`CHATIFY_SAVED_MESSAGES_ENABLED`	`true`
Giphy	`giphy.enabled`	`CHATIFY_GIPHY_ENABLED`	`true`
Colors	`colors.enabled`	`CHATIFY_COLORS_ENABLED`	`true`
Themes	`themes.enabled`	`CHATIFY_THEMES_ENABLED`	`true`
Fonts	`fonts.enabled`	`CHATIFY_FONTS_ENABLED`	`true`
Wallpaper	`chat_background.enabled`	`CHATIFY_WALLPAPER_ENABLED`	`true`
Sounds (master)	`sounds.enabled`	`CHATIFY_SOUNDS_ENABLED`	`true`
Incoming sound	`sounds.incoming_message.enabled`	`CHATIFY_SOUND_INCOMING_ENABLED`	`true`
Outgoing sound	`sounds.outgoing_message.enabled`	`CHATIFY_SOUND_OUTGOING_ENABLED`	`true`
Typing sound	`sounds.typing.enabled`	`CHATIFY_SOUND_TYPING_ENABLED`	`false`
Locale middleware	`locale.middleware`	`CHATIFY_LOCALE_MIDDLEWARE`	`true`
Gravatar	`gravatar.enabled`	--	`true`
Expose email	`api.expose_email`	`CHATIFY_EXPOSE_EMAIL`	`false`

Configuration

On this page