-
Notifications
You must be signed in to change notification settings - Fork 1
/
config.yaml
163 lines (163 loc) · 5.58 KB
/
config.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
options:
version:
type: string
description: errbot version to install
backend:
type: string
description: |
The type of chat server errbot will connect with. Choose from:
IRC, XMPP, Telegram, Hipchat, Slack, Text or Graphic.
default: IRC
chatrooms:
type: string
description: Comma separated list of room names to join.
default: ""
nickname:
type: string
description: The bot's nickname.
default: errbot
prefix:
type: string
description: |
Command prefix to use, e.g. if set to "!", !dosomething will run the dosomething
command in a room or on private message to the bot.
default: "!"
prefix_optional_on_chat:
type: boolean
description: Whether to allow ommitting the prefix if talking in private chat.
default: true
alt_prefixes:
type: string
description: Comma separated list of alternative command prefixes to allow.
default: ""
fullname:
type: string
description: |
Full name for display in chatrooms, mostly important for Hipchat/XMPP which
use it for connecting and joining rooms, if not set will default to nickname.
server:
type: string
description: Server address/hostname to connect to the chat server with.
server_port:
type: int
description: Optional port number to connect to the chat server with.
server_tls:
type: boolean
description: If true, connect to the chat server with TLS/SSL.
default: true
username:
type: string
description: Optional username to connect to the chat server with.
password:
type: string
description: Optional password to connect to the chat server with.
nickserv_password:
type: string
description: Optional NickServ password, if using the IRC backend.
hipchat_endpoint:
type: string
description: Optional Hipchat endpoint if using self-hosted Hipchat.
default: https://api.hipchat.com
token:
type: string
description: Connection token for Slack and Telegram chat servers.
hipchat_token:
type: string
description: API token for Hipchat if using group admin functions in plugins.
auto_install_plugin_deps:
type: boolean
description: If true, errbot will install plugin dependencies automatically.
default: false
sentry_dsn:
type: string
description: A Sentry/Raven DSN to use for logging with getsentry.com or self-hosted Sentry.
admins:
type: string
description: Comma separated list of bot admins.
default: ""
default_access_controls:
type: string
description: |
Python dict defining *default* access controls for commands/plugins.
"{}" means allow all by default.
default: "{}"
access_controls:
type: string
description: Python dict defining access controls for rooms, users and plugins/commands.
hide_restricted_commands:
type: boolean
description: If true, commands restricted by access control will not show in help output.
default: false
hide_restricted_access:
type: boolean
description: If true, no error will be displayed if a user attempts a command they don't have access to.
default: false
divert_to_private:
type: string
description: |
Comma separated list of commands that should always be responded to
in private, even if issued in multi-user chat.
default: ""
chatroom_relay:
type: string
description: |
Python dict defining users whose output should be relayed to
certain rooms, This can be useful with XMPP notifiers like for
example the standard Altassian Jira which don't have native support for MUC.
reverse_chatroom_relay:
type: string
description: |
Python dict defining rooms to forward output to specific users.
It can be useful if you client like gtalk doesn't support MUC correctly.
message_size_limit:
type: int
description: Optional message length, anything above will be broken up into smaller messages.
groupchat_nick_prefixed:
type: boolean
description: If true, responses in a multi-user chat can be directed at specific users.
default: true
compact_output:
type: boolean
description: If true table borders are not displayed in responses.
default: true
suppress_cmd_not_found:
type: boolean
description: If true errbot will not display an error for unknown commands.
default: false
nagios_context:
type: string
description: Context for Nagios checks
default: errbot
enable_webserver:
type: boolean
description: Enable errbot's webserver, required for webhooks
default: true
plugin_repos:
type: string
description: Python dict defining extra plugin repos to install.
default: "{}"
plugins_config:
type: string
description: Python dict defining plugin configuration.
default: "{}"
wheels_repo:
type: string
decription: |
A repository to pull python wheels from, either an HTTP index (ala PyPI), git repo,
bzr repo, svn repo, hg repo, or URL to a tarball of wheels.
wheels_repo_revision:
type: string
decription: If wheels_repo_type is a VCS, this defines a specific revision to use.
wheels_repo_type:
type: string
description: |
Type of repo in "wheels_repo", either git, bzr, svn, hg, tar or http.
(https and pypi also work as aliases for http).
default: http
private_ssh_key:
type: string
description: base64 encoded private SSH key to use for authenticated wheel repos (not HTTP).
update_ssh_known_hosts:
type: boolean
description: Whether SSH known_hosts file should be updated automatically from the wheels_repo host.
default: false