<commit_before># docker-err

[Err](http://errbot.net) - the pluggable chatbot

## Bot runtime config

See [config-template.py](https://raw.githubusercontent.com/gbin/err/master/errbot/config-template.py) for settings documentation.

Environment       | Default
----------------- | -----------
BACKEND           | XMPP
BOT_LOG_LEVEL     | INFO
BOT_USERNAME      |
BOT_PASSWORD      |
BOT_SERVER        |
BOT_ADMINS        | admin@localhost
CHATROOM_PRESENCE | <EMAIL>
CHATROOM_FN       | Err
XMPP_CA_CERT_FILE | None

## Quickstart example
<commit_msg>Add environment vars and descriptions to readme<commit_after># docker-err

[Err](http://errbot.net) - the pluggable chatbot

## Bot runtime config

See [config-template.py](https://raw.githubusercontent.com/gbin/err/master/errbot/config-template.py) for settings documentation.

Environment       | Default                      | Description
----------------- | ---------------------------- | --------------------
BACKEND           | XMPP                         | Chat server type. (XMPP, Text, HipChat, Slack, IRC)
BOT_LOG_LEVEL     | INFO                         | Change log level
BOT_USERNAME      |                              | The JID of the user
BOT_PASSWORD      |                              | The corresponding password for the user
BOT_TOKEN         |                              | Token for HipChat and Slack backend
BOT_SERVER        |                              | Server address for XMPP and HipChat
BOT_PORT          |                              | Server port
BOT_SSL           | false                        | IRC Backend: Use SSL
BOT_ENDPOINT      |                              | HipChat endpoint for hosted HipChat
BOT_NICKNAME      |                              | IRC Backend: Nickname
BOT_ADMINS        | admin@localhost              | Bot admins seperated with comma
CHATROOM_PRESENCE | <EMAIL>     | The FullName, or nickname, your bot should use
CHATROOM_FN       | Err                          | Chatrooms your bot should join on startup
XMPP_CA_CERT_FILE | None                         | Path to a file containing certificate authorities
BOT_PREFIX        | !                            | Command prefix

## Quickstart example

{'fraction_non_alphanumeric': 0.10388437217705511, 'fraction_numerical': 0.0, 'mean_word_length': 1.4915635545556805, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 13, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3883682', 'n_tokens_mistral': 592, 'n_tokens_neox': 573, 'n_words': 157}