Forever
![Software License][ico-license]
![Total Downloads][ico-downloads], (*1)
Forever broadcasting., (*2)
Install
NPM
Add the required Nodejs Packages., (*3)
``` bash
npm install --save forever ioredis socket.io, (*4)
#### Via Composer
Require the `multimedia-street/forever` package in your composer.json and update your dependencies.
``` bash
$ composer require multimedia-street/forever
Add Service Provider
Include the Service Provider to your config/app.php
in providers array, (*5)
``` php
Mmstreet\Forever\ServiceProvider::class,, (*6)
#### Optional Publish Configuration
You can publish the configuration.
``` bash
$ php artisan vendor:publish --provider="Mmstreet\Forever\ServiceProvider"
This will create config/forever.php
., (*7)
port
Port number for forever listen. Default 3000
, (*8)
channel
Channel of the forever. This will be added on broadcastOn()
array of your events, if your events implements the interface ShouldBroadcast
. Default global
., (*9)
Commands
Example usage
``` bash
$ php artisan forever:start, (*10)
##### `forever:generate`
Generate a `forever.js` file to your base app.
##### `forever:start`
Start the forever service. This also generate a `forever.js`
##### `forever:stop` `[-c|--clear]`
Stop the forever service. Option `--clear` will also delete the logs afterwards, this is only calling the `forever:clear`
##### `forever:clear`
Clear the forever logs.
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details., (*11)
Security
If you discover any security related issues, please email :author_email instead of using the issue tracker., (*12)
Credits
License
The MIT License (MIT). Please see License File for more information., (*13)