PHPackages                             launcher/mercurius - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. launcher/mercurius

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

launcher/mercurius
==================

 Real-time Messenger package for Laravel

0.0.10(7y ago)32256750[20 issues](https://github.com/launcher-host/mercurius/issues)[1 PRs](https://github.com/launcher-host/mercurius/pulls)MITPHPPHP ^7.1.3

Since Oct 10Pushed 7y ago24 watchersCompare

[ Source](https://github.com/launcher-host/mercurius)[ Packagist](https://packagist.org/packages/launcher/mercurius)[ Docs](https://launcher.host/mercurius/)[ RSS](/packages/launcher-mercurius/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (10)Dependencies (6)Versions (16)Used By (0)

 [ ![](docs/logo-mercurius-bold.png "Mercurius - Messenger for Laravel") ](https://www.github.com/launcher-host/mercurius/)

[![Build Status](https://camo.githubusercontent.com/382a4c12958f7491b08a91ae6391aeb571d7d1aaa900797a4ae23039e47f7024/68747470733a2f2f7472617669732d63692e6f72672f6c61756e636865722d686f73742f6d65726375726975732e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/launcher-host/mercurius)[![Build Status](https://camo.githubusercontent.com/ba3dfa05621a1b4ab92d3fede5726ad5f3a5a107812ec55625adc7d6fb3cf012/68747470733a2f2f7374796c6563692e696f2f7265706f732f3134373930333430382f736869656c643f7374796c653d666c6174)](https://styleci.io/repos/147903408/shield?style=flat)[![Latest Version](https://camo.githubusercontent.com/be5cbb7418d913efb875b35305904becdb4a87ecc83d6fb34e0b628389f8355e/68747470733a2f2f706f7365722e707567782e6f72672f6c61756e636865722f6d65726375726975732f762f737461626c652e7376673f666f726d61743d666c6174)](https://packagist.org/packages/launcher/mercurius)[![Total Downloads](https://camo.githubusercontent.com/3c058ebeb055b43f7a81088a0fe22f5d8844babdee27ac3114d4e829b4dd1cf5/68747470733a2f2f706f7365722e707567782e6f72672f6c61756e636865722f6d65726375726975732f646f776e6c6f6164732e7376673f666f726d61743d666c6174)](https://packagist.org/packages/launcher/mercurius)[![License](https://camo.githubusercontent.com/15bf60cb971b82d5ce8c128556466cbcb00e99fcf89bccb2684e8ce6806027e3/68747470733a2f2f706f7365722e707567782e6f72672f6c61756e636865722f6d65726375726975732f6c6963656e73652e7376673f666f726d61743d666c6174)](https://packagist.org/packages/launcher/mercurius)

Table of Contents
-----------------

[](#table-of-contents)

- [About](#about)
- [Preview](#preview)
- [Features](#features)
- [Screenshots](#screenshots)
- [Demo](#demo)
- [Installation](#installation)
- [Customization](#customization)
- [Roadmap](#roadmap)
- [Support](#support)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [Credits](#credits)
- [Copyright &amp; License](#copyright-and-license)

About
-----

[](#about)

Mercurius is a real-time messenger system using Laravel and Vue.js, featuring a complete application that you can easily install with any Laravel project.

Preview
-------

[](#preview)

[ ![](docs/mercurius_preview_2018-oct.gif "mercurius preview")](docs/mercurius_preview_2018-oct.gif)
Features
--------

[](#features)

- Real-time Messenger
- Responsive
- Multilingual
- Browser notifications
- Unique UX, with dark theme
- Typing indicator
- Remove conversations and messages
- Search recipients with auto-complete

Screenshots
-----------

[](#screenshots)

 [![](docs/mercurius_01_home_tb.png)](docs/mercurius_01_home.png "screenshot mercurius - no conversations") [![](docs/mercurius_02_view_conversation_tb.png)](docs/mercurius_02_view_conversation.png "screenshot mercurius - view conversation") [![](docs/mercurius_03_messages_hover_tb.png)](docs/mercurius_03_messages_hover.png "screenshot mercurius - messages hover")

 [![](docs/mercurius_04_compose_message_tb.png)](docs/mercurius_04_compose_message.png "screenshot mercurius - compose message") [![](docs/mercurius_05_find_recipient_results_tb.png)](docs/mercurius_05_find_recipient_results.png "screenshot mercurius - find recipient results") [![](docs/mercurius_06_user_settings_tb.png)](docs/mercurius_06_user_settings.png "screenshot mercurius - user settings")

Click thumbs to enlarge image
Demo
----

[](#demo)

You can [try a demo](http://mercurius-demo.herokuapp.com/login) of Mercurius. Authenticate using any of the following credentials:

- `ian@launcher.host`
- `noa@launcher.host`
- `lua@launcher.host`

Password: `password`

Tip: Open 2 different browsers and login with different usernames, so you can test send/receiving messages.

Installation
------------

[](#installation)

Make sure Laravel `5.6`+ is installed before proceed.

##### 1. Setup Pusher

[](#1-setup-pusher)

If you don't have an account, create a free one on [pusher.com website](https://pusher.com/). Go to the dashboard, create a new app and take note of the API credentials.

Now, let's add the API keys to the `.env` file. Also, change the `BROADCAST_DRIVER` to `pusher` (default is `log`).

```
...
BROADCAST_DRIVER=pusher
...
PUSHER_APP_ID="xxxxxx"
PUSHER_APP_KEY="xxxxxxxxxxxxxxxxxxxx"
PUSHER_APP_SECRET="xxxxxxxxxxxxxxxxxxxx"
PUSHER_APP_CLUSTER="xx"
```

##### 2. Register `BroadcastServiceProvider`

[](#2-register-broadcastserviceprovider)

Open `config/app.php` and uncomment the line `App\Providers\BroadcastServiceProvider::class,`.

##### 3. Laravel Authentication

[](#3-laravel-authentication)

Skip this step if authentication is already setup, otherwise type:

```
php artisan make:auth
```

##### 4. Install Mercurius

[](#4-install-mercurius)

```
composer require launcher/mercurius
```

##### 5. Configuration (optional)

[](#5-configuration-optional)

If you want to change the default configuration, publish the config file, by typing the command:

```
php artisan vendor:publish --tag=mercurius-config
```

For editing the config, open `/config/mercurius.php` and add your own values.

```
return [

    /*
    |--------------------------------------------------------------------------
    | Mercurius Models
    |--------------------------------------------------------------------------
    |
    | Defines the models used with Mercurius, use it to extend Mercurius and
    | create your own implementation.
    |
    */

    'models' => [
        'user' => App\User::class,
        'messages' => Launcher\Mercurius\Models\Message::class,
    ],

    /*
    |--------------------------------------------------------------------------
    | User Table Fields
    |--------------------------------------------------------------------------
    |
    | You can specify the column names for the user table. The `name` accepts
    | an array of fields, for building custom names with multiple columns.
    |
    */

    'fields' => [
        // 'name'   => ['first_name', 'last_name'],
        'name'   => 'name',
        'slug'   => 'slug',
        'avatar' => 'avatar',
    ],
];
```

##### 6. Install Mercurius

[](#6-install-mercurius)

```
php artisan mercurius:install
composer dump-autoload
```

##### 7. User trait

[](#7-user-trait)

Add `Launcher\Mercurius\MercuriusUser` trait to your `User` model:

```
// ...
use Illuminate\Foundation\Auth\User as Authenticatable;
use Launcher\Mercurius\MercuriusUser;

class User extends Authenticatable
{
    use MercuriusUser;
    // ...
}
```

##### 8. Install dummy data (for testing)

[](#8-install-dummy-data-for-testing)

```
php artisan db:seed --class=MercuriusDatabaseSeeder
```

Will add Messages and Users to the system, like in the [demo example](#demo):

Demo Users:

- Ian: `ian@launcher.host`
- Noa: `noa@launcher.host`
- Lua: `lua@launcher.host`

Password: `password`

#### Update Mercurius

[](#update-mercurius)

Whenever you update Mercurius, make sure to publish assets to apply the new versions of CSS/JS.

```
php artisan vendor:publish --tag=mercurius-public --force
```

Customization
-------------

[](#customization)

Please see [Customization](docs/customization.md) for more information.

Roadmap
-------

[](#roadmap)

Check the [roadmap](https://github.com/launcher-host/mercurius/issues/8) for more information.

- Unit Tests
- Conversation w/ multiple users #13
- Webhooks #16
- Upload photos &amp; files #14
- Preview images and videos #15
- Emoji support #18
- Video Chat #19
- Support socket.io #20
- Search messages #17

Support
-------

[](#support)

- Create a [new issue](../../issues)
- Join us on [Slack Channel](http://mercurius-demo.herokuapp.com/join-slack-launcher-host)

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for more information.

Changelog
---------

[](#changelog)

We keep a [CHANGELOG](CHANGELOG.md) with the information that has changed.

Credits
-------

[](#credits)

- [Bruno Torrinha](https://torrinha.com)
- [All Contributors](../../contributors)

Copyright and license
---------------------

[](#copyright-and-license)

Copyright 2018 [Bruno Torrinha](https://torrinha.com). Mercurius is released under the [MIT License](LICENSE).

###  Health Score

35

—

LowBetter than 79% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity34

Limited adoption so far

Community23

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 85.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~3 days

Total

13

Last Release

2736d ago

Major Versions

0.0.10 → 1.0.0-alpha2018-11-09

PHP version history (2 changes)0.0.1PHP ^7.0 || ^7.1

0.0.7PHP ^7.1.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/1a89580ab50d2df849a26dc6460519f35f5a494b949957dc45097c453950afff?d=identicon)[akazorg](/maintainers/akazorg)

---

Top Contributors

[![akazorg](https://avatars.githubusercontent.com/u/34574?v=4)](https://github.com/akazorg "akazorg (108 commits)")[![quetzyg](https://avatars.githubusercontent.com/u/1413966?v=4)](https://github.com/quetzyg "quetzyg (10 commits)")[![tiagojpdias](https://avatars.githubusercontent.com/u/13319957?v=4)](https://github.com/tiagojpdias "tiagojpdias (4 commits)")[![pmmaga](https://avatars.githubusercontent.com/u/1273069?v=4)](https://github.com/pmmaga "pmmaga (3 commits)")[![alextime](https://avatars.githubusercontent.com/u/11634019?v=4)](https://github.com/alextime "alextime (1 commits)")

---

Tags

chatchat-applicationlaravellaravel-chatlaravel-messengerlaravel-packagemessengerphppushervuewebsocketsphplaravelpusherchatMessengervueweb-sockets

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/launcher-mercurius/health.svg)

```
[![Health](https://phpackages.com/badges/launcher-mercurius/health.svg)](https://phpackages.com/packages/launcher-mercurius)
```

###  Alternatives

[munafio/chatify

A package for Laravel PHP Framework to add a complete real-time chat system.

2.4k441.9k2](/packages/munafio-chatify)[lexxyungcarter/chatmessenger

Simple one-to-one/group chat messaging tool for Laravel 5, 6, 7, 8, 9 &amp; 10 with Pusher Integration

10724.1k](/packages/lexxyungcarter-chatmessenger)[syntaxlexx/chatmessenger

Simple one-to-one/group chat messaging tool for Laravel 5, 6, 7, 8, 9 &amp; 10 with Pusher Integration

10510.2k](/packages/syntaxlexx-chatmessenger)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
