{"id":15147061,"url":"https://github.com/rroemhild/docker-errbot","last_synced_at":"2025-09-29T15:32:08.828Z","repository":{"id":20897061,"uuid":"24184574","full_name":"rroemhild/docker-errbot","owner":"rroemhild","description":"Dockerfile for Err - the pluggable chatbot","archived":true,"fork":false,"pushed_at":"2023-08-03T23:07:24.000Z","size":57,"stargazers_count":58,"open_issues_count":2,"forks_count":49,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-09-23T07:45:21.579Z","etag":null,"topics":["bot","docker","errbot","hipchat","irc","slack","xmpp"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rroemhild.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-09-18T10:51:05.000Z","updated_at":"2024-05-23T04:23:54.000Z","dependencies_parsed_at":"2024-09-21T19:01:28.500Z","dependency_job_id":null,"html_url":"https://github.com/rroemhild/docker-errbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rroemhild%2Fdocker-errbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rroemhild%2Fdocker-errbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rroemhild%2Fdocker-errbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rroemhild%2Fdocker-errbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rroemhild","download_url":"https://codeload.github.com/rroemhild/docker-errbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219874624,"owners_count":16554602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","docker","errbot","hipchat","irc","slack","xmpp"],"created_at":"2024-09-26T12:21:58.058Z","updated_at":"2025-09-29T15:32:03.549Z","avatar_url":"https://github.com/rroemhild.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rroemhild/errbot\n\n![Docker Build Status](https://img.shields.io/docker/build/rroemhild/errbot.svg) ![Docker Stars](https://img.shields.io/docker/stars/rroemhild/errbot.svg) ![Docker Pulls](https://img.shields.io/docker/pulls/rroemhild/errbot.svg)\n\n- [Introduction](#introduction)\n- [Quick Start](#quick-start)\n- [Configuration](#configuration)\n    - [Image Runtime Config](#image-runtime-config)\n    - [Bot Runtime Config](#bot-runtime-config)\n- [Persistence](#persistence)\n- [Use your own config file](#use-your-own-config-file)\n- [Run Err with extra arguments](#run-err-with-extra-arguments)\n    - [Alternative config file](#alternative-config-file)\n    - [Err Help](#err-help)\n    - [Run with text debug backend](#run-with-text-debug-backend)\n- [Exposed Ports](#exposed-ports)\n\n# Introduction\n\nDockerfile to build an [Errbot](http://errbot.io) (the pluggable chatbot) container image.\n\nVersion: `latest`\nDocker: `rroemhild/errbot`\n\n# Quick Start\n\n```\ndocker run -d \\\n    --name err \\\n    -e BOT_USERNAME=err@xmmp.local \\\n    -e BOT_PASSWORD=errbotpwd \\\n    -e BOT_ADMINS=admin@xmpp.local \\\n    -e CHATROOM_PRESENCE=err@conference.xmpp.local \\\n    -e \"TZ=Europe/Berlin\" \\\n    rroemhild/errbot\n```\n\nor try the docker compose example\n\n```bash\nwget https://raw.githubusercontent.com/rroemhild/docker-err/master/docker-compose.yml\ndocker-compose up\n```\n\n# Configuration\n\n## Image Runtime Config\n\n- **WAIT**: Seconds to sleep before starting the bot. Defaults to `None`\n\n## Bot Runtime Config\n\nBelow is the complete list of available options that can be used to customize your Err bot. See [config-template.py](https://raw.githubusercontent.com/gbin/err/master/errbot/config-template.py) for complete settings documentation.\n\n- **BACKEND**: Chat server type. (XMPP, Text, HipChat, Slack, IRC). Defaults to `XMPP`.\n- **BOT_LOG_LEVEL**: Change log level. Defaults to `INFO`.\n- **BOT_USERNAME**: The UID for the bot user.\n- **BOT_PASSWORD**: The corresponding password for the user.\n- **BOT_TOKEN**: Token for HipChat and Slack backend.\n- **BOT_SERVER**: Server address for XMPP and HipChat.\n- **BOT_PORT**: Server port.\n- **BOT_SSL**: Use SSL for IRC backend. Default to `False`.\n- **BOT_ENDPOINT**: HipChat endpoint for hosted HipChat.\n- **BOT_NICKNAME**: Nickname for IRC backend.\n- **BOT_ADMINS**: Bot admins separated with comma. Defaults to `admin@localhost`.\n- **CHATROOM_PRESENCE**: Chatrooms your bot should join on startup.\n- **CHATROOM_FN**: The FullName, or nickname, your bot should use. Defaults to `Err`.\n- **XMPP_CA_CERT_FILE**: Path to a file containing certificate authorities. Default to `None`.\n- **BOT_PREFIX**: Command prefix for the bot. Default to `!`.\n- **BOT_PREFIX_OPTIONAL_ON_CHAT**: Optional prefix for normal chat. Default to `False`.\n- **BOT_ALT_PREFIXES**: Alternative prefixes.\n- **BOT_ALT_PREFIX_SEPARATORS**: Alternative prefixes separators.\n- **BOT_ALT_PREFIX_CASEINSENSITIVE**:  Require correct capitalization. Defaults to `False`.\n- **HIDE_RESTRICTED_COMMANDS**: Hide the restricted commands from the help output. Defaults to `False`.\n- **HIDE_RESTRICTED_ACCESS**: Do not reply error message. Defaults to `False`.\n- **DIVERT_TO_PRIVATE**: Private commands.\n- **MESSAGE_SIZE_LIMIT**: Maximum length a single message may be. Defaults to `10000`.\n- **BOT_EXTRA_PLUGIN_DIR**: Directory to load extra plugins from. Defaults to `/srv/plugins`.\n- **CORE_PLUGINS**: comma-separated subset of the core plugins to load. Defaults to all plugins which are bundled with Errbot.\n\n# Persistence\n\nFor storage of the application data, you should mount a volume at\n\n* `/srv`\n\nCreate the directories for the volume\n\n```bash\nmkdir /tmp/errbot /tmp/errbot/ssl /tmp/errbot/data /tmp/errbot/plugins\nchmod -R 777 /tmp/errbot\n```\n\n# Use your own config file\n\n```bash\ncurl -sL https://raw.githubusercontent.com/gbin/err/master/errbot/config-template.py -o /tmp/errbot/config.py\n```\n\n# Run Err with extra arguments\n\nIf you pass arguments to Errbot you have to set the `-c /srv/config.py` argument by your self to run with the default config.\n\n## Alternative config file\n\n```bash\ndocker run -it -v /tmp/errbot:/srv rroemhild/errbot -c /srv/production.py\n```\n\n## Err Help\n\n```bash\n$ docker run rroemhild/errbot -h\n```\n\n## Run with text debug backend\n\n```bash\ndocker run -it -v /tmp/errbot:/srv rroemhild/errbot -c /srv/config.py -T\n```\n\n# Exposed Ports\n\n* 3142 (Webserver if configured)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frroemhild%2Fdocker-errbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frroemhild%2Fdocker-errbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frroemhild%2Fdocker-errbot/lists"}