Skip to content

Drupal module installation and configuration

Jump to bottom
Andrey Maximov edited this page Jun 1, 2021 · 5 revisions

Installation

Drupal module is hosted at Github - https://github.com/fivejars/openy_vyva

Prerequisites

You should have Open Y Virtual Y modules installed. See https://github.com/ymcatwincities/openy_gated_content.

With Composer 2+

With Composer 2+ the installation should be as simple as composer require fivejars/vyva.

With Composer 1.x

Try installing it with composer require fivejars/vyva.

If it fails, it means that the package is not going to be available at packagist for composer 1.x.

Edit you root composer.json file, add the package information to the repositories sections:

{
    "type": "package",
    "package": {
        "name": "fivejars/vyva",
        "version": "1.0.0",
        "type": "drupal-module",
        "dist": {
            "url": "https://github.com/fivejars/openy_vyva/archive/1.0.0.zip",
            "type": "zip"
        }
    }
}

Now install it with composer require fivejars/vyva.

Installation within Drupal

Install like any other Drupal module:

  1. Login as an administrator.
  2. Go to Admin Menu > Extend.
  3. Find the "Virtual Y Video Automation", tick the checkbox next to it, click on the "Install" button.
  4. Verify that the module is installed:
    1. there is Admin menu > Virtual Y > Virtual YMCA settings > Video Automation menu item;
    2. it navigates to the Video Automation settings form.

Configuration

Pre- and post-rolls

The first 2 fields of the Video Automation settings form are Pre-roll video and Post-roll video.

The fields should contain positive integers referencing Vimeo-hosted videos by their ID, e.g. if the video is accessible at https://vimeo.com/143013949 then 143013949 is supposed to be put in the field.

The pre-roll video will be prepended and the post-roll will be appended to all processed videos. At the moment there is only one set of pre- and post-roll videos.

The videos must be uploaded to your Vimeo account for the system to be able to download them.

Notification settings

When a video processing completes, the module creates a Virtual Y Video node and sends an email.

You can specify recipients in the Emails field. Separate emails by comma.

The Email template allows you to control the contents of the email.

Establishing secure communication with the conversion tool

AUTHENTICATION SETTINGS and WEBHOOK AUTHENTICATION are covered in https://github.com/fivejars/vyva/wiki/Configure-secure-communication.

Vimeo settings

VIMEO SETTINGS are covered in https://github.com/fivejars/vyva/wiki/Vimeo-configuration

Auto-generated Thumbnail settings

The auto-generated thumbnails allow you to generate the thumbnails out of HTML. The module provides a special page that takes some attributes in query parameters and outputs them in the page content which is crafted from a special template. The conversion tool is supplied with software that allows taking screenshots of such an HTML page.

These configuration sections allow you to alter the look and feel of that page and configure how to access the screenshot service.

Cachet

You must specify the paths relative to root to 3 variations of the Cachet font. You must link the WOFF files.

Screenshots

The Screenshot Service URL field should be filled with the link https://%CONVERSION_TOOL_DOMAIN%/shot, where %CONVERSION_TOOL_DOMAIN% is the domain name for the conversion tool.

Credentials

If your website is protected by HTTP Basic Authentication the Screenshot service won't able to open the auto-generated thumbnails page. This section lets you specify the username and password for the Screenshot service to pass the authentication.

Clone this wiki locally