Mibew/auto-invite-plugin
1
0
Fork 0
mirror of https://github.com/Mibew/auto-invite-plugin.git synced 2024-11-21 11:50:31 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
A plugin for Mibew Messenger to automatically invite a visitor into chat
4 Commits 1 Branch 1 Tag 13 KiB
PHP 84.6%
JavaScript 15.4%
master
Go to file
Fedor A. Fetisov f3519bedba Switch go Gulp 4 for builds
2021-01-30 00:03:33 +03:00
.gitignore Disable versioning for package-lock.json 2021-01-29 23:57:26 +03:00
gulpfile.js Switch go Gulp 4 for builds 2021-01-30 00:03:33 +03:00
LICENSE Initial commit 2018-09-25 22:29:09 +03:00
package.json Switch go Gulp 4 for builds 2021-01-30 00:03:33 +03:00
Plugin.php Initial commit 2018-09-25 22:29:09 +03:00
README.md Initial commit 2018-09-25 22:29:09 +03:00

README.md

Auto Invite plugin

A plugin to automatically invite a visitor into chat.

Based on idea of this code.

Installation

  1. Get the archive with the plugin sources. You can download it from the official site or build the plugin from sources.

  2. Untar/unzip the plugin's archive.

  3. Put files of the plugins to the <Mibew root>/plugins folder.

  4. (optional) Add plugins configs to "plugins" structure in "<Mibew root>/configs/config.yml". If the "plugins" stucture looks like plugins: [] it will become:

    plugins:
    "Mibew:AutoInvite": # Plugin's configurations are described below
        wait_time: 30
        strategy: random
        group: 0

  5. Navigate to "<Mibew Base URL>/operator/plugin" page and enable the plugin.

Plugin's configurations

The plugin can be configured with values in "<Mibew root>/configs/config.yml" file.

config.wait_time

Type: Integer

Default: 60

Specify time in seconds to wait before sending an invitation.

config.strategy

Type: String

Default: first

Invitation strategy (i.e. how to choose an operator on behalf of whom the invitation will be sent). At the moment there are two options available: first (first available operator will be used) and random (speaks for itself).

config.group

Type: Integer

Default: 0

What group to choose operator from. Note that if there will be no available operators from that group the invitation will not be sent.

Build from sources

There are several actions one should do before use the latest version of the plugin from the repository:

  1. Obtain a copy of the repository using git clone, download button, or another way.
  2. Install node.js and npm.
  3. Install Gulp.
  4. Install npm dependencies using npm install.
  5. Run Gulp to build the sources using gulp default.

Finally .tar.gz and .zip archives of the ready-to-use Plugin will be available in release directory.

License

Apache License 2.0