README.md

err-cloud-init

Err chatbot plugin to accept cloud-init phone_home module requests.

Installation and usage

To use this plugin you'll need to configure and activate Webserver plugin first:

!plugin config Webserver {'HOST': '0.0.0.0', 'PORT': 3141 }

This will configure Errbot to listen to requests on all interfaces on port 3141.

Install the plugin:

!repos install https://github.com/br0ziliy/err-cloud-init.git

notify configuration should contain a text representation of message recipient (this value will be used with build_identifier() call). Plugin does not check if a user or channel exist upon sending a message, it's up to you to supply a valid channel/username. For information about valid identifiers for various backends see Identifiers section below.

Example cloud-init user-data config:

phone_home:
    url: http://example.com:3141/cloud_init/$INSTANCE_ID
    post: all
    tries: 3

Commands

Currently, plugin does not expose any commands

Identifiers

List of valid identifiers for various backends:

• IRC

#channel
user

• Slack

<#C12345>
<@U12345>
<@U12345|user>
@user
#channel/user
#channel

• Telegram

Any positive integer. Telegram usernames not supported.

• XMPP

Any XEP-0030-compatible JID string. Usually it's as simple as user@my.jabber.host.com or chatroom@my.jabber.host.com

• HipChat

Same as XMPP

• Campfire [UNTESTED]

User name as seen in the Campfire chat room.

• Skype [UNTESTED]

A Skype ID.

• Tox [UNTESTED]

A Tox hash.