mirror of
https://github.com/mediacms-io/mediacms.git
synced 2026-02-04 14:32:59 -05:00
63 lines
2.9 KiB
Markdown
63 lines
2.9 KiB
Markdown
# MediaCMS for Moodle
|
|
|
|
This package provides the integration between MediaCMS and Moodle (versions 4.x and 5.x).
|
|
It consists of two components that work together to provide a seamless video experience:
|
|
|
|
1. **Filter (filter_mediacms):** Handles the display of videos using secure LTI 1.3 launches. It also provides the "Auto-convert" feature to turn URLs into players.
|
|
2. **Editor Plugin (tiny_mediacms):** Adds a "Insert MediaCMS Video" button to the TinyMCE editor, allowing users to select videos from the MediaCMS library or paste URLs.
|
|
|
|
## Installation
|
|
|
|
This package is distributed as a single repository but contains two standard Moodle plugins that must be installed in their respective directories.
|
|
|
|
### 1. Copy Files
|
|
|
|
Copy the directories into your Moodle installation as follows:
|
|
|
|
* Copy `filter/mediacms` to `YOUR_MOODLE_ROOT/filter/mediacms`.
|
|
* Copy `tiny/mediacms` to `YOUR_MOODLE_ROOT/lib/editor/tiny/plugins/mediacms`.
|
|
|
|
### 2. Set Permissions
|
|
|
|
Ensure the web server user (typically `www-data`) has ownership of the new directories:
|
|
|
|
```bash
|
|
# Example for Ubuntu/Debian systems
|
|
chown -R www-data:www-data YOUR_MOODLE_ROOT/filter/mediacms
|
|
chown -R www-data:www-data YOUR_MOODLE_ROOT/lib/editor/tiny/plugins/mediacms
|
|
chmod -R 755 YOUR_MOODLE_ROOT/filter/mediacms
|
|
chmod -R 755 YOUR_MOODLE_ROOT/lib/editor/tiny/plugins/mediacms
|
|
```
|
|
|
|
### 3. Install Plugins
|
|
|
|
1. Log in to Moodle as an Administrator.
|
|
2. Go to **Site administration > Notifications**.
|
|
3. Follow the prompts to upgrade the database and install the new plugins.
|
|
|
|
## Configuration
|
|
|
|
All configuration is centralized in the Filter settings. You do **not** need to configure the TinyMCE plugin separately.
|
|
|
|
1. Go to **Site administration > Plugins > Filters > Manage filters**.
|
|
2. Enable **MediaCMS** (set it to "On").
|
|
3. Click **Settings** next to MediaCMS.
|
|
4. **MediaCMS URL:** Enter the base URL of your MediaCMS instance (e.g., `https://video.example.com`).
|
|
5. **LTI Tool:** Select the External Tool configuration that corresponds to MediaCMS.
|
|
* *Note:* You must first create an LTI 1.3 External Tool in *Site administration > Plugins > Activity modules > External tool > Manage tools*.
|
|
6. **Auto-convert:** Check "Enable auto-convert" if you want plain text URLs (e.g., `https://video.example.com/view?m=xyz`) to automatically become video players.
|
|
|
|
## Usage
|
|
|
|
### For Teachers (Editor)
|
|
|
|
1. In any text editor (TinyMCE), click the **MediaCMS** icon (or "Insert MediaCMS Video" from the Insert menu).
|
|
2. You can:
|
|
* **Paste a URL:** Paste a View or Embed URL.
|
|
* **Video Library:** Click the "Video Library" tab to browse and select videos (requires LTI Deep Linking configuration).
|
|
3. The video will appear as a placeholder or iframe in the editor.
|
|
|
|
### For Students (Display)
|
|
|
|
When content is viewed, the Filter will ensure the video is loaded securely via LTI 1.3, authenticating the user with MediaCMS automatically.
|