README.md 1.67 KB
Newer Older
Marcello Pivanti's avatar
Marcello Pivanti committed
1
2
3
4
5
6
7
8
9
10
11
# Videoconference Plugin #

Plugin for E015 common modules.

## Installation

### 1. The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```bash
waltermazza's avatar
waltermazza committed
12
composer require arter/amos-videoconference
Marcello Pivanti's avatar
Marcello Pivanti committed
13
14
15
16
17
```

or add this row

```
waltermazza's avatar
waltermazza committed
18
"arter/amos-videoconference": "dev-master"
Marcello Pivanti's avatar
Marcello Pivanti committed
19
20
21
22
23
24
25
26
27
28
29
```

to the require section of your `composer.json` file.


### 2. Add module to your main config in common:
	
```php
<?php
'modules' => [
    'videoconference' => [
waltermazza's avatar
waltermazza committed
30
        'class' => 'arter\amos\videoconference\AmosVideoconference',
Marcello Pivanti's avatar
Marcello Pivanti committed
31
32
33
34
35
36
37
38
        'rbacEnabled' => false,
    ],
],
```

### 3. Apply migrations

```bash
waltermazza's avatar
waltermazza committed
39
php yii migrate/up --migrationPath=@vendor/arter/amos-videoconference/src/migrations
Marcello Pivanti's avatar
Marcello Pivanti committed
40
41
42
43
44
45
46
```

or add this row to your migrations config in console:

```php
<?php
return [
waltermazza's avatar
waltermazza committed
47
    '@vendor/arter/amos-videoconference/src/migrations',
Marcello Pivanti's avatar
Marcello Pivanti committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
];
```

### 4. Configuration for sending email from console

insert in /console/component-others.php
```php
    'urlManager' => [
        'class' => 'yii\web\UrlManager',
    'baseUrl' => '/',
    'hostInfo' => 'http://example.org',
        // Disable index.php
        'showScriptName' => false,
        // Disable r= routes
        'enablePrettyUrl' => true,
        'rules' => array(
            '<module:[\w-]+>/<controller:[\w-]+>/<action:[\w-]+>/<id:\d+>] => <module>/<controller>/<action>',
        ),
    ],
```
change the paramater 'hostInfo' with the base url of your application, it is required for insert images inside the email template.

### 5. Console command for crons
The console command to launch the cron is:
```bash
php yii videoconference/cron/start_video_conference
```
```bash
php yii videoconference/cron/send_email_reminder
```