attakei / errbot-backend-webapp

Web UI based backend interface for Errbot (not Webhook feature).

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Errbot Webapp backend plugin

https://travis-ci.com/attakei/errbot-backend-webapp.svg?branch=master

This is alpha-level implementation. Use only local

Web UI based backend interface for Errbot (not Webhook feature).

Overview

This plugin can exchange messages Errbot and any browsers by WebSocket. It may be able to supply public chat-bot on a website with Errbot.

Demo

./demo.gif

Features

  • Exchange messages by WebSocket
  • HTML for reference implementtion

Usage

Prerequirements

You must ready environment to run Errbot(>=6.0.x).

Installation

As single source

Clone this project and configure to use as extra-backend for Errbot.

$ cd /path/to/your-errbot-env
$ git clone https://github.com/attakei/errbot-backend-webapp.git
$ pip install -r errbot-backend-webapp/requirements.txt
BOT_EXTRA_BACKEND_DIR = './errbot-backend-webapp'
BACKEND = 'Webapp'

As PyPI package

$ cd /path/to/your-errbot-env
$ pip install errbot-backend-webapp
import errbot_backend_webapp

BOT_EXTRA_BACKEND_DIR = errbot_backend_webapp.get_plugin_dir()
BACKEND = 'Webapp'

Configuration

Webapp host and port can configure by your config.py. Plugin see BOT_IDENTITY.

BOT_IDENTITY = {
    'host': '127.0.0.1',  # Listen host. default is 'localhost'
    'port': 8001,         # Listen port. default is 8080
}

To Do

  • Configuration static resource dir
  • Authorize by session

License

GPLv3. See it

About

Web UI based backend interface for Errbot (not Webhook feature).

License:GNU General Public License v3.0


Languages

Language:Python 63.4%Language:JavaScript 31.6%Language:HTML 3.7%Language:Makefile 1.3%