teltek/pmk2-lms-bundle

Pumukit Lms Bundle.

4.0.0 2024-08-21 10:25 UTC

Requires

• php: ^8.2
• pumukit/pumukit: ^4.0

proprietary

• Teltek Team

• symfony
• bundle
• moodle
• lms
• pumukit
• openedx

README

Bundle based on Symfony to work with the PuMuKIT Video Platform.

The goal of this bundle is to merge the common APIs between the Moodle bundle and the OpenEDX bundle into single generic bundle.

This code includes:

• An Atto Editor integration for Moodle (/Resources/data/pumoodle/editor/atto/plugins)
• A common API and endpoints that are shared for OpenEDX and Moodle

For the OpenEDX integration, an XBlock is also needed:

• PuMuKIT2 Opencast Video XBlock

The new Atto Editor integration for Moodle is meant to replace the classical integration through a mix of repository/filter/block plugins here At the moment, there are a couple of missing features:

• Moodle Playlists support
• Search and publish public videos (published on the WebTV channel)

Installation steps

Requirements

Steps 1 and 2 requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 1: Introduce repository in the root project composer.json

Open a command console, enter your project directory and execute the following command to add this repo:

$ composer config repositories.pumukitlmsbundle vcs https://github.com/teltek/pumukit-lms-bundle.git

Step 2: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require teltek/pumukit-lms-bundle dev-master

Step 3: Install the Bundle

Add the next line on bundles.php file:

Pumukit\LmsBundle\PumukitLmsBundle::class => ['all' => true]

Add the next lines on config/routes/annotations.yaml file:

pumukit_lms:
    resource: "@PumukitLmsBundle/Resources/config/routing.yml"
    prefix:   /

Step 4: Configure Bundle

Go to Resources/doc/Configuration.md

Step 5: Install LMS Publication Channel

Install the LMS Publication Channel with tag code PUCHLMS.

$ cd /path/to/pumukit/
$ php bin/console pumukit:lms:init:pubchannel

Step 6: Add the PUCHLMS tag code to the desire encoder profiles

Edit your config/packages/pumukit_encoder.yaml profile to add the PUCHLMS tag code to the desire encoder profiles, so in case a multimedia object has this Tag, the Tracks with those profiles will be generated.

For example, if you want to generate a video_h264 Track each time the LMS Publication Channel is added to a Multimedia Object, you should add the tag code this way:

pumukit_encoder:
    ...
    profiles:
        video_h264:
	    ...
            target: PUCHWEBTV PUCHPODCAST PUCHLMS

For PuMuKIT the latest version ( higher than 2.3.x ) , add this configuration to config/packages/pumukit_encoder.yaml as well:

pumukit_encoder:
    target_default_profiles:
        PUCHLMS:
            video: "video_h264"

Step 7: (Optional) Set the permissions

Add the "Init Multimedia Objects in published status" role to those users with a permission profile with personal scope, if you want them to publish their own videos immediately. Example for "Auto Publisher" permission profile:

php app/console pumukit:permission:update "Auto Publisher" ROLE_INIT_STATUS_PUBLISHED

Step 8: Override PumukitNewAdminBundle:MultimediaObject:list.html.twig template

Run the pumukit:lms:init:resources command the branch corresponding to your PuMuKIT version:

php bin/console pumukit:lms:init:resources 4.x

If your current version gives an error, please open an issue on GitHub.

Clear cache:

php bin/console cache:clear
php bin/console cache:clear --env=prod

Documentation

1. Configuration

2.- Plugin list