klongchu/laravel-jitsi

A package to generate view of a Jitsi Meet room using Jitsi Meet IFrame API

1.0.2 2023-12-26 13:46 UTC

This package is auto-updated.

Last update: 2024-11-26 15:41:48 UTC


README

Latest Version on Packagist Build Status Total Downloads

A package to generate view of a Jitsi Meet room using Jitsi Meet IFrame API.

Jitsi Meet Prerequisites

Your Jitsi Meet host must use the token authentication. Currently this package also require your Jitsi Host to allow anonymous user to join by configuring the anonymousdomain (might change later).

If you are self-hosting your Jitsi Meet instance, here are some article that might help:

Installation

You can install the package via composer:

composer require klongchu/laravel-jitsi

Add these variables to your .env file

# Domain of the jitsi meet instance
JITSI_APP_DOMAIN=
# App id
JITSI_APP_ID=
# Secret key used to generate jwt
JITSI_APP_SECRET=

Add the trait \Klongchu\LaravelJitsi\Traits\HasJitsiAttributes to your User model.

use Klongchu\LaravelJitsi\Traits\HasJitsiAttributes;
use Illuminate\Notifications\Notifiable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    <...>
    use HasJitsiAttributes;
    <...>
}

Simple Usage

In your web.php route file, call the jitsi route macro.

Route::jitsi();

Then visit /jitsi/<room name> to join a conference call. Visiting this url when you are authenticated will set your display name, email, avatar and also grant you the moderator role.

TODO: More Usage

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email amy.azmim@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.