- Introduction
- Quick Start
- Configuration
- Persistence
- Use your own config file
- Run Err with extra arguments
- Exposed Ports
Dockerfile to build an Errbot (the pluggable chatbot) container image.
docker run -d \
--name err \
-e BACKEND=Slack \
-e [email protected] \
-e CHATROOM_PRESENCE=milind,iotspbot,bipeen.sawant \
-e BOT_TOKEN=xoxb-197423219299-HtY88HbbQ9R9UzLCUlLBx1g1 \
-e BOT_LOG_LEVEL=DEBUG \
bipeen/devops-errbot
- First create a slack team https://slack.com/create
- Now create a bot user for your slack team https://my.slack.com/services/new/bot This bot user will enable to interact with any external service in our case its errbot. Note the name of bot user created in step 2 we need it to set BOT_ADMINS env while building the devops-errbot.
- Also note the api-token of the created bot user and set it as BOT_TOKEN env.
- WAIT: Seconds to sleep before starting the bot. Defaults to
None
Below is the complete list of available options that can be used to customize your Err bot. See config-template.py for complete settings documentation.
- BACKEND: Chat server type. (XMPP, Text, HipChat, Slack, IRC). Defaults to
XMPP
. - BOT_LOG_LEVEL: Change log level. Defaults to
INFO
. - BOT_USERNAME: The UID for the bot user.
- BOT_PASSWORD: The corresponding password for the user.
- BOT_TOKEN: Token for HipChat and Slack backend.
- BOT_SSL: Use SSL for IRC backend. Default to
False
. - BOT_ENDPOINT: HipChat endpoint for hosted HipChat.
- BOT_NICKNAME: Nickname for IRC backend.
- BOT_ADMINS: Bot admins separated with comma. Defaults to
admin@localhost
. Count should be less than 3. - CHATROOM_PRESENCE: Chatrooms your bot should join on startup.
- CHATROOM_FN: The FullName, or nickname, your bot should use. Defaults to
Err
. - BOT_PREFIX: Command prefix for the bot. Default to
!
. - BOT_PREFIX_OPTIONAL_ON_CHAT: Optional prefix for normal chat. Default to
False
. - BOT_ALT_PREFIXES: Alternative prefixes.
- BOT_ALT_PREFIX_SEPARATORS: Alternative prefixes separators.
- BOT_ALT_PREFIX_CASEINSENSITIVE: Require correct capitalization. Defaults to
False
. - HIDE_RESTRICTED_COMMANDS: Hide the restricted commands from the help output. Defaults to
False
. - MESSAGE_SIZE_LIMIT: Maximum length a single message may be. Defaults to
10000
.
For storage of the application data, you should mount a volume at
/srv
Create the directories for the volume
mkdir /tmp/errbot /tmp/errbot/ssl /tmp/errbot/data /tmp/errbot/plugins
chmod -R 777 /tmp/errbot
curl -sL https://raw.githubusercontent.com/gbin/err/master/errbot/config-template.py -o /tmp/errbot/config.py
If you pass arguments to Errbot you have to set the -c /srv/config.py
argument by your self to run with the default config.
docker run -it -v /tmp/errbot:/srv bipeens/Devops-errbot -c /srv/production.py
$ docker run bipeens/Devops-errbot -h
docker run -it -v /tmp/errbot:/srv bipeens/Devops-errbot -c /srv/config.py -T
- 3142 (Webserver if configured)