PHPackages                             twedoo/volcator - 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. [Framework](/categories/framework)
4. /
5. twedoo/volcator

ActiveLibrary[Framework](/categories/framework)

twedoo/volcator
===============

Twedoo Volcator to build applications fast, comes with multiples modules configurable, that provides modern content management system (CMS).

3.10(2y ago)61102MITJavaScriptPHP ^8.1

Since Aug 5Pushed 2y ago2 watchersCompare

[ Source](https://github.com/Twedoo/volcator)[ Packagist](https://packagist.org/packages/twedoo/volcator)[ Docs](https://github.com/twedoo/volcator)[ RSS](/packages/twedoo-volcator/feed)WikiDiscussions main Synced today

READMEChangelog (2)Dependencies (15)Versions (8)Used By (0)

Volcator
========

[](#volcator)

[![Latest Version on Packagist](https://camo.githubusercontent.com/1be440a72617eef5c077619a6fa1b3bee0068c39c883245954ee4cc04218b391/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f747765646f6f2f766f6c6361746f722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/twedoo/volcator)[![Total Downloads](https://camo.githubusercontent.com/f49a7fb8fc929426a90f28db3eb1b0a1f0a76bfcc247e1837dc388bba46e2c15/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f747765646f6f2f766f6c6361746f722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/twedoo/volcator)[![Build Status](https://camo.githubusercontent.com/43b54abed21b86ef22ba2fead3d9ae788cad896902f34f38034e7b0c38d96ada/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f747765646f6f2f766f6c6361746f722f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/twedoo/volcator)

This is where your description should go. Take a look at [contributing.md](contributing.md) to see a to do list.

Version
-------

[](#version)

This volcator version in 3.x is not ready for use yet !
We are working hard and smart to get it to the production stage ^^ !
We have dealine **August 28, 2022**

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

[](#installation)

Via Composer

```
$ composer require twedoo/volcator
```

Publish volcator views and translate (lang):

```
php artisan vendor:publish --provider="Twedoo\Volcator\VolcatorServiceProvider"
```

Usage
-----

[](#usage)

From Laravel scratch project install default migration table of Laravel and Volcator (**Should add DB connection in .env and launch commands**):

```
$ php artisan volcator:migration
```

```
$ php artisan migrate:install
```

```
$ php artisan migrate
```

```
php artisan volcator:seeder
```

In another way use command one line:

```
php artisan volcator:migration && php artisan migrate:install && php artisan migrate && php artisan volcator:seeder

```

From existing project:
----------------------

[](#from-existing-project)

```
$ php artisan volcator:migration
```

Migrate all volcator tables:

```
$ php artisan migrate
```

Change model User App\\Models\\User to :
----------------------------------------

[](#change-model-user-appmodelsuser-to-)

```
namespace App\Models;

use Twedoo\VolcatorGuard\Models\User as VolcatorUser;

class User extends VolcatorUser
{
    /**
     *
     */
}

```

It's done :D refresh your application !

For developers (Mode Dev)
-------------------------

[](#for-developers-mode-dev)

Only mode Dev use command one line to purge all Volcator tables and regenerate them automatically:

```
php artisan volcator:migration -p true && php artisan volcator:migration  && php artisan migrate:install && php artisan migrate && php artisan volcator:seeder

```

### Config web socket with Devilbox

[](#config-web-socket-with-devilbox)

```
npm run dev && php artisan websockets:serve --host=127.0.0.1

```

Should run this command in same container of project to mount host websocket laravel

### Soketi env variables

[](#soketi-env-variables)

```
{
    ADAPTER_DRIVER: 'adapter.driver',
    ADAPTER_REDIS_PREFIX: 'adapter.redis.prefix',
    APP_MANAGER_DRIVER: 'appManager.driver',
    APP_MANAGER_DYNAMODB_TABLE: 'appManager.dynamodb.table',
    APP_MANAGER_DYNAMODB_REGION: 'appManager.dynamodb.region',
    APP_MANAGER_DYNAMODB_ENDPOINT: 'appManager.dynamodb.endpoint',
    APP_MANAGER_MYSQL_TABLE: 'appManager.mysql.table',
    APP_MANAGER_MYSQL_VERSION: 'appManager.mysql.version',
    APP_MANAGER_POSTGRES_TABLE: 'appManager.postgres.table',
    APP_MANAGER_POSTGRES_VERSION: 'appManager.postgres.version',
    APP_MANAGER_MYSQL_USE_V2: 'appManager.mysql.useMysql2',
    CHANNEL_LIMITS_MAX_NAME_LENGTH: 'channelLimits.maxNameLength',
    DEBUG: 'debug',
    DEFAULT_APP_ID: 'appManager.array.apps.0.id',
    DEFAULT_APP_KEY: 'appManager.array.apps.0.key',
    DEFAULT_APP_SECRET: 'appManager.array.apps.0.secret',
    DEFAULT_APP_MAX_CONNS: 'appManager.array.apps.0.maxConnections',
    DEFAULT_APP_ENABLE_CLIENT_MESSAGES: 'appManager.array.apps.0.enableClientMessages',
    DEFAULT_APP_ENABLED: 'appManager.array.apps.0.enabled',
    DEFAULT_APP_MAX_BACKEND_EVENTS_PER_SEC: 'appManager.array.apps.0.maxBackendEventsPerSecond',
    DEFAULT_APP_MAX_CLIENT_EVENTS_PER_SEC: 'appManager.array.apps.0.maxClientEventsPerSecond',
    DEFAULT_APP_MAX_READ_REQ_PER_SEC: 'appManager.array.apps.0.maxReadRequestsPerSecond',
    DEFAULT_APP_WEBHOOKS: 'appManager.array.apps.0.webhooks',
    DB_POOLING_ENABLED: 'databasePooling.enabled',
    DB_POOLING_MIN: 'databasePooling.min',
    DB_POOLING_MAX: 'databasePooling.max',
    DB_MYSQL_HOST: 'database.mysql.host',
    DB_MYSQL_PORT: 'database.mysql.port',
    DB_MYSQL_USERNAME: 'database.mysql.user',
    DB_MYSQL_PASSWORD: 'database.mysql.password',
    DB_MYSQL_DATABASE: 'database.mysql.database',
    DB_POSTGRES_HOST: 'database.postgres.host',
    DB_POSTGRES_PORT: 'database.postgres.port',
    DB_POSTGRES_USERNAME: 'database.postgres.user',
    DB_POSTGRES_PASSWORD: 'database.postgres.password',
    DB_POSTGRES_DATABASE: 'database.postgres.database',
    DB_REDIS_HOST: 'database.redis.host',
    DB_REDIS_PORT: 'database.redis.port',
    DB_REDIS_DB: 'database.redis.db',
    DB_REDIS_USERNAME: 'database.redis.username',
    DB_REDIS_PASSWORD: 'database.redis.password',
    DB_REDIS_KEY_PREFIX: 'database.redis.keyPrefix',
    DB_REDIS_SENTINELS: 'database.redis.sentinels',
    DB_REDIS_SENTINEL_PASSWORD: 'database.redis.sentinelPassword',
    DB_REDIS_INSTANCE_NAME: 'database.redis.name',
    EVENT_MAX_CHANNELS_AT_ONCE: 'eventLimits.maxChannelsAtOnce',
    EVENT_MAX_NAME_LENGTH: 'eventLimits.maxNameLength',
    EVENT_MAX_SIZE_IN_KB: 'eventLimits.maxPayloadInKb',
    METRICS_ENABLED: 'metrics.enabled',
    METRICS_DRIVER: 'metrics.driver',
    METRICS_PROMETHEUS_PREFIX: 'metrics.prometheus.prefix',
    METRICS_SERVER_PORT: 'metrics.port',
    PORT: 'port',
    PATH_PREFIX: 'pathPrefix',
    PRESENCE_MAX_MEMBER_SIZE: 'presence.maxMemberSizeInKb',
    PRESENCE_MAX_MEMBERS: 'presence.maxMembersPerChannel',
    QUEUE_DRIVER: 'queue.driver',
    QUEUE_REDIS_CONCURRENCY: 'queue.redis.concurrency',
    RATE_LIMITER_DRIVER: 'rateLimiter.driver',
    SSL_CERT: 'ssl.certPath',
    SSL_KEY: 'ssl.keyPath',
    SSL_PASS: 'ssl.passphrase',
};
```

### Variable .env VolcatorEcho

[](#variable-env-volcatorecho)

```
PUSHER_STONE_FORCE_TLS=
PUSHER_STONE_ENCRYPTED=
PUSHER_STONE_WS_HOST='127.0.0.1'
PUSHER_STONE_WS_PORT=6001
PUSHER_STONE_WSS_PORT=6001

MIX_PUSHER_STONE_FORCE_TLS="${PUSHER_STONE_FORCE_TLS}"
MIX_PUSHER_STONE_ENCRYPTED="${PUSHER_STONE_ENCRYPTED}"
MIX_PUSHER_STONE_WS_HOST="${PUSHER_STONE_WS_HOST}"
MIX_PUSHER_STONE_WS_PORT="${PUSHER_STONE_WS_PORT}"
MIX_PUSHER_STONE_WSS_PORT="${PUSHER_STONE_WSS_PORT}"
```

### Pusher call method

[](#pusher-call-method)

```

import Echo from './echo.js';
import {Pusher} from './pusher.js';
window.Pusher = Pusher;

window.VolcatorEcho =  new Echo({
    broadcaster: 'pusher',
    key: window.PUSHER_APP_KEY,
    cluster: window.PUSHER_APP_CLUSTER,
    forceTLS: !!window.PUSHER_STONE_FORCE_TLS,
    wsHost: window.PUSHER_STONE_WS_HOST,
    wsPort: window.PUSHER_STONE_WS_PORT,
    wssPort: window.PUSHER_STONE_WSS_PORT,
    encrypted: !!window.PUSHER_STONE_ENCRYPTED,
    enabledTransports: ['ws', 'wss']
});

window.VolcatorEcho.channel('notification.'+window.currentUserId).listen('.notifyNotification', (event) => {
    toastr.success('Hé, ça marche !', 'View history');
    console.log(event);
});

```

Change log
----------

[](#change-log)

Please see the [changelog](changelog.md) for more information on what has changed recently.

Testing
-------

[](#testing)

```
$ composer test
```

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

[](#contributing)

Please see [contributing.md](contributing.md) for details and a todolist.

Security
--------

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Houssem MAAMRIA](https://github.com/twedoo)
- [All Contributors](../../contributors)

License
-------

[](#license)

MIT. Please see the [license file](license.md) for more information.

###  Health Score

29

—

LowBetter than 57% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 100% 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 ~210 days

Total

4

Last Release

797d ago

Major Versions

1.3 → 3.02023-08-15

PHP version history (2 changes)1.2PHP ^7.2|^8.0

3.10PHP ^8.1

### Community

Maintainers

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

---

Top Contributors

[![kurollo](https://avatars.githubusercontent.com/u/7980607?v=4)](https://github.com/kurollo "kurollo (94 commits)")

---

Tags

laravelcmsMulti-ApplicationMulti-SpacesVolcator

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/twedoo-volcator/health.svg)

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

###  Alternatives

[unopim/unopim

UnoPim Laravel PIM

10.5k2.4k](/packages/unopim-unopim)[bagisto/bagisto

Bagisto Laravel E-Commerce

27.6k172.1k9](/packages/bagisto-bagisto)[statamic/cms

The Statamic CMS Core Package

4.8k3.6M986](/packages/statamic-cms)[krayin/laravel-crm

Krayin CRM

23.2k33.6k1](/packages/krayin-laravel-crm)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k15](/packages/tempest-framework)[october/rain

October Rain Library

1601.7M83](/packages/october-rain)

PHPackages © 2026

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