PHPackages                             statamic/collaboration - 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 & Helpers](/categories/utility)
4. /
5. statamic/collaboration

ActiveStatamic-addon[Utility & Helpers](/categories/utility)

statamic/collaboration
======================

Real-time collaboration and multi-user authoring for Statamic Pro.

v1.0.1(10mo ago)3688.4k—8.8%14[10 issues](https://github.com/statamic/collaboration/issues)[2 PRs](https://github.com/statamic/collaboration/pulls)proprietaryJavaScript

Since May 13Pushed 3mo ago4 watchersCompare

[ Source](https://github.com/statamic/collaboration)[ Packagist](https://packagist.org/packages/statamic/collaboration)[ RSS](/packages/statamic-collaboration/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (2)Versions (18)Used By (0)

Collaboration
=============

[](#collaboration)

> Real-time collaboration and multi-user authoring for Statamic Pro.

Note

This addon hasn't been updated for Statamic 6 yet. We're planning to tackle it soon, but don't have a firm ETA.

Features
--------

[](#features)

- Presence indicators when multiple people have the same entry opened.
- Fields get locked when someone else focuses them.
- Updates to field values are reflected to everyone.

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

[](#installation)

You can install and configure the Collaboration addon using a single command:

```
php please install:collaboration

```

The command will install the `statamic/collaboration` addon, setup Laravel's broadcast scaffolding and prompt you to select which broadcast driver you wish to use.

For more information on the specifics for each broadcast driver, please review the following:

### Laravel Reverb

[](#laravel-reverb)

The `install:collaboration` command will install Laravel Reverb into your application. After installation, run `php artisan reverb:start` to run Reverb's WebSockets server, then the Collaboration addon should start working in the Control Panel.

When you deploy your application to a server, you will need to run the Reverb WebSockets server as a daemon (`php artisan reverb:start`). If you're using Laravel Forge, there's a Reverb toggle in your site's "Application" panel.

For further information on Reverb, please review the [Laravel documentation](https://laravel.com/docs/master/reverb#introduction).

### Pusher

[](#pusher)

The `install:collaboration` command will install [Pusher](https://pusher.com/)'s PHP SDK into your application. After installation, you should add your Pusher credentials to your `.env` file:

```
PUSHER_APP_ID="your-pusher-app-id"
PUSHER_APP_KEY="your-pusher-key"
PUSHER_APP_SECRET="your-pusher-secret"
PUSHER_HOST=
PUSHER_PORT=443
PUSHER_SCHEME="https"
PUSHER_APP_CLUSTER="mt1"

```

You should also ensure you have enabled the "Client Events" setting (found under the "App Settings" page in the Pusher Dashboard).

### Other

[](#other)

If you're planning on using a different broadcasting driver, there are a few additional steps you'll need to take to get it working:

1. Install & configure your broadcasting driver (obviously)
2. Update the `BROADCAST_DRIVER` in your `.env`
3. Create a `resources/js/cp.js` file and add it to the Control Panel.
    - [For more information, follow this guide on our documentation site](https://statamic.dev/extending/control-panel#adding-css-and-js-assets).
4. In your `resources/js/cp.js` file, register a callback to override Statamic's [Echo](https://laravel.com/docs/10.x/broadcasting#client-side-installation) config:

```
Statamic.booting(() => {
    Statamic.$echo.config(() => ({
        broadcaster: "pusher",
        key: Statamic.$config.get('broadcasting.pusher.key'),
        cluster: Statamic.$config.get('broadcasting.pusher.cluster'),
        wsHost: Statamic.$config.get('broadcasting.pusher.host'),
        wsPort: Statamic.$config.get('broadcasting.pusher.port'),
        wssPort: Statamic.$config.get('broadcasting.pusher.port'),
        forceTLS: false,
        encrypted: true,
        disableStats: true,
        enabledTransports: ["ws", "wss"],
    }));
});
```

Configuration
-------------

[](#configuration)

### Sound Effects

[](#sound-effects)

By default, the Collaboration addon plays sound effects when other users join & leave entries.

If you wish to disable these, you may publish the configuration file (via `php artisan vendor:publish --tag=collaboration`) and set `sound_effects` to `false`.

```
// config/collaboration.php

return [
    'sound_effects' => false,
];
```

Advanced Usage
--------------

[](#advanced-usage)

When the ["meta data"](https://statamic.dev/extending/fieldtypes#meta-data) of a fieldtype is updated, it will be broadcast to the other users in the channel. If you have a fieldtype that contains a large amount of meta data, and it gets updated (some may just provide initial state and never change), you may consider specifying the fields that should be broadcast. This could help keep message sizes smaller and improve performance.

In your fieldtype's `preload` method, you can use the special `__collaboration` key to list the fields.

```
public function preload()
{
    return [
        'hello' => 'world',
        'foo' => 'bar',
        '__collaboration' => ['foo'],
    ];
}
```

When the meta data gets updated, only the `foo` value will be broadcast. The remaining values will get merged in automatically.

###  Health Score

51

—

FairBetter than 96% of packages

Maintenance64

Regular maintenance activity

Popularity44

Moderate usage in the ecosystem

Community23

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 55.6% 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 ~116 days

Recently: every ~154 days

Total

14

Last Release

323d ago

Major Versions

v0.8.1 → v1.0.02024-05-09

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1669353?v=4)[Statamic](/maintainers/statamic)[@statamic](https://github.com/statamic)

---

Top Contributors

[![jasonvarga](https://avatars.githubusercontent.com/u/105211?v=4)](https://github.com/jasonvarga "jasonvarga (60 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (12 commits)")[![duncanmcclean](https://avatars.githubusercontent.com/u/19637309?v=4)](https://github.com/duncanmcclean "duncanmcclean (11 commits)")[![jesseleite](https://avatars.githubusercontent.com/u/5187394?v=4)](https://github.com/jesseleite "jesseleite (8 commits)")[![jackmcdade](https://avatars.githubusercontent.com/u/44739?v=4)](https://github.com/jackmcdade "jackmcdade (5 commits)")[![wiebkevogel](https://avatars.githubusercontent.com/u/54707973?v=4)](https://github.com/wiebkevogel "wiebkevogel (3 commits)")[![helloiamlukas](https://avatars.githubusercontent.com/u/15997450?v=4)](https://github.com/helloiamlukas "helloiamlukas (1 commits)")[![granitibrahimi](https://avatars.githubusercontent.com/u/16402164?v=4)](https://github.com/granitibrahimi "granitibrahimi (1 commits)")[![lotarbo](https://avatars.githubusercontent.com/u/1766890?v=4)](https://github.com/lotarbo "lotarbo (1 commits)")[![robdekort](https://avatars.githubusercontent.com/u/69107412?v=4)](https://github.com/robdekort "robdekort (1 commits)")[![ryanmitchell](https://avatars.githubusercontent.com/u/51899?v=4)](https://github.com/ryanmitchell "ryanmitchell (1 commits)")[![sauerbraten](https://avatars.githubusercontent.com/u/1760908?v=4)](https://github.com/sauerbraten "sauerbraten (1 commits)")[![tao](https://avatars.githubusercontent.com/u/1446331?v=4)](https://github.com/tao "tao (1 commits)")[![theutz](https://avatars.githubusercontent.com/u/756348?v=4)](https://github.com/theutz "theutz (1 commits)")[![bradfloodx](https://avatars.githubusercontent.com/u/1085976?v=4)](https://github.com/bradfloodx "bradfloodx (1 commits)")

---

Tags

collaborationcollaborative-editingmulti-userwebsockets

### Embed Badge

![Health badge](/badges/statamic-collaboration/health.svg)

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

###  Alternatives

[statamic/seo-pro

65440.7k](/packages/statamic-seo-pro)[statamic-rad-pack/runway

Eloquently manage your database models in Statamic.

135192.6k5](/packages/statamic-rad-pack-runway)[statamic/ssg

Generate static sites with Statamic.

254302.4k](/packages/statamic-ssg)[jacksleight/statamic-bard-texstyle

17172.5k](/packages/jacksleight-statamic-bard-texstyle)[visuellverstehen/statamic-classify

A useful helper to add CSS classes to all HTML tags generated by the bard editor.

20116.8k](/packages/visuellverstehen-statamic-classify)[marcorieser/statamic-livewire

A Laravel Livewire integration for Statamic.

2381.5k10](/packages/marcorieser-statamic-livewire)

PHPackages © 2026

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