mirror of
https://github.com/zulip/zulip.git
synced 2026-07-12 21:04:41 +08:00
Update API Docs to talk about Bots and how to create them
Since we've made it easy to use bots instead of creating entirely new user accounts for things which act as bots, we've needed to update the documentation. This commit covers the static html documentation we have on humbug's API. (imported from commit 4ddbf0331588b0f463a9920b4cd363b68e811ca5)
This commit is contained in:
parent
a58876e733
commit
d021aebf54
@ -20,16 +20,21 @@
|
||||
|
||||
<h3>Installation instructions</h3>
|
||||
<p>This package uses distutils, so you can just run <code>python setup.py install</code> after downloading.</p>
|
||||
<p> </p>
|
||||
|
||||
<p>You can find your API key and allocate new API keys for
|
||||
bots/integrations that you run on your <a href="/#settings"
|
||||
target="_blank">settings page</a>.
|
||||
Create <code>~/.humbugrc</code> and add the following text to
|
||||
it:</p>
|
||||
<h3>API Keys</h3>
|
||||
<p>You can create bots on your <a href="/#settings" target="_blank">settings page</a>.
|
||||
Once you have a bot, you can use its email and API key to send messages.</p>
|
||||
|
||||
<p>Create a bot:<img class="screenshot" src="/static/images/api/create-bot.png" /></p>
|
||||
|
||||
<p>Look for the bot's email and API key:<img class="screenshot" src="/static/images/api/bot-key.png" /></p>
|
||||
|
||||
<p>If you prefer to send messages as your own user, you can find your API key also on your <a href="/#settings" target="_blank">settings page</a>.</p>
|
||||
<p>When using our python bindings, you must specify the user and API key. Alterantively, if you don't, it will look for these credentials in <code>~/.humbugrc</code>, which you can create as follows:</p>
|
||||
<div class="codehilite"><pre><span class="k">[api]</span>
|
||||
<span class="na">key</span><span class="o">=</span><span class="s">API_KEY</span>
|
||||
<span class="na">email</span><span class="o">=</span><span class="s">EMAIL_ADDRESS</span>
|
||||
<span class="na">key</span><span class="o">=</span><span class="s">BOT_API_KEY</span>
|
||||
<span class="na">email</span><span class="o">=</span><span class="s">BOT_EMAIL_ADDRESS</span>
|
||||
</pre></div>
|
||||
|
||||
<p><strong>Don't want to make it yourself?</strong> Humbug <a href="/integrations">already integrates with lots of services</a>.</p>
|
||||
@ -56,7 +61,7 @@ to pull out the resulting HTML :)
|
||||
|
||||
<h4>Stream message</h4>
|
||||
<div class="codehilite"><pre>curl https://humbughq.com/api/v1/messages <span class="se">\</span>
|
||||
-u YOUR_EMAIL:YOUR_API_KEY <span class="se">\</span>
|
||||
-u BOT_EMAIL_ADDRESS:BOT_API_KEY <span class="se">\</span>
|
||||
-d <span class="s2">"type=stream"</span> <span class="se">\</span>
|
||||
-d <span class="s2">"to=Denmark"</span> <span class="se">\</span>
|
||||
-d <span class="s2">"subject=Castle"</span> <span class="se">\</span>
|
||||
@ -65,7 +70,7 @@ to pull out the resulting HTML :)
|
||||
|
||||
<h4>Private message</h4>
|
||||
<div class="codehilite"><pre>curl https://humbughq.com/api/v1/messages <span class="se">\</span>
|
||||
-u YOUR_EMAIL:YOUR_API_KEY <span class="se">\</span>
|
||||
-u BOT_EMAIL_ADDRESS:BOT_API_KEY <span class="se">\</span>
|
||||
-d <span class="s2">"type=private"</span> <span class="se">\</span>
|
||||
-d <span class="s2">"to=wdaher@humbughq.com"</span> <span class="se">\</span>
|
||||
-d <span class="s2">"content=I come not, friends, to steal away your hearts."</span>
|
||||
@ -77,7 +82,9 @@ to pull out the resulting HTML :)
|
||||
<div class="codehilite"><pre><span class="c">#!/usr/bin/env python</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">humbug</span>
|
||||
<span class="n">client</span> <span class="o">=</span> <span class="n">humbug</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="p">)</span>
|
||||
<span class="c"># Keyword arguments 'email' and 'api_key' are optional if you are using ~/.humbugrc</span>
|
||||
<span class="n">client</span> <span class="o">=</span> <span class="n">humbug</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="p">email</span><span class="o">=</span><span class="s">"othello-bot@example.com"</span><span class="p">,</span>
|
||||
<span class="n">api_key</span><span class="o">=</span><span class="s">"a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5"</span><span class="p">)</span>
|
||||
|
||||
<span class="n">stream_message</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s">"type"</span><span class="p">:</span> <span class="s">"stream"</span><span class="p">,</span>
|
||||
@ -105,15 +112,19 @@ to pull out the resulting HTML :)
|
||||
<p>You can use <code>humbug-send</code> (found in <code>bin/</code> in the tarball) to easily send Humbugs from the command-line, providing the message to be sent on STDIN.
|
||||
|
||||
<h4>Stream message</h4>
|
||||
<div class="codehilite"><pre>humbug-send --stream Denmark --subject Castle</span></pre></div>
|
||||
<div class="codehilite"><pre>humbug-send --stream Denmark --subject Castle \
|
||||
--user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5</span></pre></div>
|
||||
|
||||
<h4>Private message</h4>
|
||||
<div class="codehilite"><pre>humbug-send wdaher@humbughq.com</span>
|
||||
<div class="codehilite"><pre>humbug-send wdaher@humbughq.com --user othello-bot@example.com \
|
||||
--api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5</span>
|
||||
</pre></div>
|
||||
|
||||
<h4>Passing in the message on the command-line</h4>
|
||||
<p>If you'd like, you can also provide the message on the command-line with the <code>-m</code> flag, as follows:</p>
|
||||
<div class="codehilite"><pre>humbug-send --stream Denmark --subject Castle -m <span class="s2">"Something is rotten in the state of Denmark."</span>
|
||||
<div class="codehilite"><pre>humbug-send --stream Denmark --subject Castle \
|
||||
-m <span class="s2">"Something is rotten in the state of Denmark."</span> \
|
||||
--user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
[
|
||||
{
|
||||
"endpoint": "GET /v1/messages/latest",
|
||||
"example_response": "<div class=\"codehilite\"><pre><span class=\"p\">{</span> <span class=\"s2\">\"messages\"</span> <span class=\"o\">:</span> <span class=\"p\">[</span> <span class=\"p\">{</span> <span class=\"s2\">\"client\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"website\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"content\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"hi\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"content_type\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"text/x-markdown\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"display_recipient\"</span> <span class=\"o\">:</span> <span class=\"p\">[</span> <span class=\"p\">{</span> <span class=\"s2\">\"email\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"wdaher@humbughq.com\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"full_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"Waseem Daher\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"short_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"wdaher\"</span>\n <span class=\"p\">},</span>\n <span class=\"p\">{</span> <span class=\"s2\">\"email\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"othello@humbughq.com\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"full_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"Othello, Moor of Venice\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"short_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"othello\"</span>\n <span class=\"p\">}</span>\n <span class=\"p\">],</span>\n <span class=\"s2\">\"gravatar_hash\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"948fcdfa93dd8986106032f1bad7f2c8\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"id\"</span> <span class=\"o\">:</span> <span class=\"mi\">400</span><span class=\"p\">,</span>\n <span class=\"s2\">\"recipient_id\"</span> <span class=\"o\">:</span> <span class=\"mi\">101</span><span class=\"p\">,</span>\n <span class=\"s2\">\"sender_email\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"othello@humbughq.com\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"sender_full_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"Othello, Moor of Venice\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"sender_short_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"othello\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"subject\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"timestamp\"</span> <span class=\"o\">:</span> <span class=\"mi\">1365532669</span><span class=\"p\">,</span>\n <span class=\"s2\">\"type\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"private\"</span>\n <span class=\"p\">}</span> <span class=\"p\">],</span>\n <span class=\"s2\">\"msg\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"result\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"success\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"update_types\"</span> <span class=\"o\">:</span> <span class=\"p\">[</span> <span class=\"s2\">\"new_messages\"</span> <span class=\"p\">]</span>\n<span class=\"p\">}</span>\n</pre></div>",
|
||||
"example_response": "<div class=\"codehilite\"><pre><span class=\"p\">{</span> <span class=\"s2\">\"messages\"</span> <span class=\"o\">:</span> <span class=\"p\">[</span> <span class=\"p\">{</span> <span class=\"s2\">\"client\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"website\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"content\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"hi\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"content_type\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"text/x-markdown\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"display_recipient\"</span> <span class=\"o\">:</span> <span class=\"p\">[</span> <span class=\"p\">{</span> <span class=\"s2\">\"email\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"wdaher@humbughq.com\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"full_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"Waseem Daher\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"short_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"wdaher\"</span>\n <span class=\"p\">},</span>\n <span class=\"p\">{</span> <span class=\"s2\">\"email\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"othello-bot@humbughq.com\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"full_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"Othello, Moor of Venice\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"short_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"othello-bot\"</span>\n <span class=\"p\">}</span>\n <span class=\"p\">],</span>\n <span class=\"s2\">\"gravatar_hash\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"948fcdfa93dd8986106032f1bad7f2c8\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"id\"</span> <span class=\"o\">:</span> <span class=\"mi\">400</span><span class=\"p\">,</span>\n <span class=\"s2\">\"recipient_id\"</span> <span class=\"o\">:</span> <span class=\"mi\">101</span><span class=\"p\">,</span>\n <span class=\"s2\">\"sender_email\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"othello-bot@humbughq.com\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"sender_full_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"Othello, Moor of Venice\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"sender_short_name\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"othello-bot\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"subject\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"timestamp\"</span> <span class=\"o\">:</span> <span class=\"mi\">1365532669</span><span class=\"p\">,</span>\n <span class=\"s2\">\"type\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"private\"</span>\n <span class=\"p\">}</span> <span class=\"p\">],</span>\n <span class=\"s2\">\"msg\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"result\"</span> <span class=\"o\">:</span> <span class=\"s2\">\"success\"</span><span class=\"p\">,</span>\n <span class=\"s2\">\"update_types\"</span> <span class=\"o\">:</span> <span class=\"p\">[</span> <span class=\"s2\">\"new_messages\"</span> <span class=\"p\">]</span>\n<span class=\"p\">}</span>\n</pre></div>",
|
||||
"returns": [
|
||||
[
|
||||
"messages",
|
||||
@ -21,7 +21,7 @@
|
||||
],
|
||||
"example_request": {
|
||||
"python": "<div class=\"codehilite\"><pre><span class=\"n\">client</span><span class=\"o\">.</span><span class=\"n\">get_messages<span class=\"p\">()</span>\n</span></pre></div>",
|
||||
"curl": "<div class=\"codehilite\"><pre>curl -G http://api.humbughq.com/v1/messages <span class=\"se\">\\</span>\n -u you@example.com:a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"last=102345\"</span>\n</pre></div>"
|
||||
"curl": "<div class=\"codehilite\"><pre>curl -G http://api.humbughq.com/v1/messages <span class=\"se\">\\</span>\n -u othello-bot@example.com:a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"last=102345\"</span>\n</pre></div>"
|
||||
}
|
||||
},
|
||||
{
|
||||
@ -54,7 +54,7 @@
|
||||
],
|
||||
"example_request": {
|
||||
"python": "<div class=\"codehilite\"><pre>\n<span class=\"n\">client</span><span class=\"o\">.</span><span class=\"n\">send_message</span><span class=\"p\">({</span>\n <span class=\"s\">\"type\"</span><span class=\"p\">:</span> <span class=\"s\">\"private\"</span><span class=\"p\">,</span>\n <span class=\"s\">\"to\"</span><span class=\"p\">:</span> <span class=\"s\">\"wdaher@humbughq.com\"</span><span class=\"p\">,</span>\n <span class=\"s\">\"content\"</span><span class=\"p\">:</span> <span class=\"s\">\"I come not, friends, to steal away your hearts.\"</span>\n<span class=\"p\">}</span>)</span>\n<span class=\"n\">client</span><span class=\"o\">.</span><span class=\"n\">send_message</span><span class=\"p\">(</span><span class=\"n\"><span class=\"p\">{</span>\n <span class=\"s\">\"type\"</span><span class=\"p\">:</span> <span class=\"s\">\"stream\"</span><span class=\"p\">,</span>\n <span class=\"s\">\"to\"</span><span class=\"p\">:</span> <span class=\"s\">\"Denmark\"</span><span class=\"p\">,</span>\n <span class=\"s\">\"subject\"</span><span class=\"p\">:</span> <span class=\"s\">\"Castle\"</span><span class=\"p\">,</span>\n <span class=\"s\">\"content\"</span><span class=\"p\">:</span> <span class=\"s\">\"Something is rotten in the state of Denmark.\"</span>\n<span class=\"p\">}</span></span><span class=\"p\">)</span>\n</pre></div>\n",
|
||||
"curl": "<h5>Stream message</h5>\n<div class=\"codehilite\"><pre>curl https://humbughq.com/api/v1/messages <span class=\"se\">\\</span>\n -u YOUR_EMAIL:YOUR_API_KEY <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"type=stream\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"to=Denmark\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"subject=Castle\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"content=Something is rotten in the state of Denmark.\"</span>\n</pre></div>\n<h5>Private message</h5>\n<div class=\"codehilite\"><pre>curl https://humbughq.com/api/v1/messages <span class=\"se\">\\</span>\n -u YOUR_EMAIL:YOUR_API_KEY <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"type=private\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"to=wdaher@humbughq.com\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"content=I come not, friends, to steal away your hearts.\"</span>\n</pre></div>"
|
||||
"curl": "<h5>Stream message</h5>\n<div class=\"codehilite\"><pre>curl https://humbughq.com/api/v1/messages <span class=\"se\">\\</span>\n -u BOT_EMAIL_ADDRESS:BOT_API_KEY <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"type=stream\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"to=Denmark\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"subject=Castle\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"content=Something is rotten in the state of Denmark.\"</span>\n</pre></div>\n<h5>Private message</h5>\n<div class=\"codehilite\"><pre>curl https://humbughq.com/api/v1/messages <span class=\"se\">\\</span>\n -u BOT_EMAIL_ADDRESS:BOT_API_KEY <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"type=private\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"to=wdaher@humbughq.com\"</span> <span class=\"se\">\\</span>\n -d <span class=\"s2\">\"content=I come not, friends, to steal away your hearts.\"</span>\n</pre></div>"
|
||||
}
|
||||
}
|
||||
]
|
||||
@ -22,14 +22,19 @@
|
||||
for thee! (Or for a team member of yours, I guess.)</p>
|
||||
|
||||
<h3>Getting started</h3>
|
||||
<p>Many of these integrations are available in
|
||||
our <a href="/api">API bindinds</a>. You may either send messages as
|
||||
yourself or use a bot which you can create. Both options are managed at your
|
||||
<a href="/#settings" target="_blank">settings page</a>.</p>
|
||||
|
||||
<p>First, for most integrations you'll need
|
||||
to <a href="/api">download and install our API bindings</a> on the
|
||||
machine where the service runs.</p>
|
||||
<p>Create a bot:
|
||||
<img class="screenshot" src="/static/images/api/create-bot.png" /></p>
|
||||
|
||||
<p>Next, please <a href="/#settings">visit your settings page and
|
||||
create a Humbug bot</a> for the integration you are setting
|
||||
up. Each bot gets its own name and API key.</p>
|
||||
<p>Look for the bot's email and API key:
|
||||
<img class="screenshot" src="/static/images/api/bot-key.png" /></p>
|
||||
|
||||
<p>You might want to take this moment to ensure that this bot's
|
||||
email address exists on your company's email server.</p>
|
||||
|
||||
<p>Then, follow the integration instructions below for the service
|
||||
you are interested in. It's as easy as that! If you run into any
|
||||
@ -60,10 +65,10 @@
|
||||
<div id="beanstalk" class="integration">
|
||||
<h4>Beanstalk</h4>
|
||||
<p>Humbug supports both SVN and Git notifications from Beanstalk. In the beanstalk web application, go to the Setup page, and choose the Integrations tab.
|
||||
Choose the <code>Webhooks</code> integration from the list presented. Make sure to replace the <code>@</code> in your email address with <code>%40</code>,
|
||||
Choose the <code>Webhooks</code> integration from the list presented. Make sure to replace the <code>@</code> in the bot's email address with <code>%40</code>,
|
||||
as Beanstalk's website will incorrectly refuse to parse a username containing a <code>@</code>.</p>
|
||||
|
||||
<p>In the URL field, enter <code>https://email:api_key@humbughq.com/api/v1/external/beanstalk</code>:</p>
|
||||
<p>In the URL field, enter <code>https://bot_email:bot_api_key@humbughq.com/api/v1/external/beanstalk</code>:</p>
|
||||
<img class="screenshot" src="/static/images/integrations/beanstalk/001.png">
|
||||
|
||||
<p><b>Congratulations! You're done!</b><br /> Whenever you do a
|
||||
@ -89,17 +94,19 @@
|
||||
<span class="n">namespace</span> <span class="ss">:notify</span> <span class="k">do</span>
|
||||
<span class="n">desc</span> <span class="s2">"Post a message to Humbug that we've deployed"</span>
|
||||
<span class="n">task</span> <span class="ss">:humbug</span> <span class="k">do</span>
|
||||
<span class="c1"># this will post to Humbug as the user defined in ~/.humbugrc</span>
|
||||
<span class="n">run_locally</span> <span class="s2">"echo ':beers: I just deployed to </span><span class="si">#{</span><span class="n">stage</span><span class="si">}</span><span class="s2">! :beers:' | humbug-send --stream commits --subject deployments || true"</span>
|
||||
<span class="c1"># this will post to Humbug as the user defined in
|
||||
# ~/.humbugrc if you omit --user and --api-key</span>
|
||||
<span class="n">run_locally</span> <span class="s2">"echo ':beers: I just deployed to </span><span class="si">#{</span><span class="n">stage</span><span class="si">}</span><span class="s2">! :beers:' | humbug-send \
|
||||
--user capistrano-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
|
||||
--stream commits --subject deployments || true"</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span>
|
||||
</pre></div>
|
||||
|
||||
<p>Some notes:</p>
|
||||
<ul>
|
||||
<li>Make sure you've created a
|
||||
filled-out <code>~/.humbugrc</code> on your Capistrano
|
||||
machine.</li>
|
||||
<li>If you prefer to not use <code>--user</code> and <code>--api-key</code> above, you can fill out <code>~/.humbugrc</code> on your Capistrano
|
||||
machine. For instructions on how to write that file, see <a href="/api">the API page</a>.</li>
|
||||
<li>You may need to change the <code>deploy</code> above to
|
||||
another step of your deployment process, if you'd like the
|
||||
notification to fire at a different time.</li>
|
||||
@ -127,7 +134,7 @@
|
||||
specify the email address and API key for your Git bot:</p>
|
||||
|
||||
|
||||
<div class="codehilite"><pre><span class="n">HUMBUG_USER</span> <span class="o">=</span> <span class="s">"git@example.com"</span>
|
||||
<div class="codehilite"><pre><span class="n">HUMBUG_USER</span> <span class="o">=</span> <span class="s">"git-bot@example.com"</span>
|
||||
<span class="n">HUMBUG_API_KEY</span> <span class="o">=</span> <span class="s">"0123456789abcdef0123456789abcdef"</span></pre></div>
|
||||
|
||||
<p>You can also specify which pushes will result in
|
||||
@ -287,7 +294,7 @@ following, to the stream <code>commits</code> with a subject that matches the re
|
||||
For self-contained JIRA installations, this will be <code>atlassian-jira/WEB-INF/classes/</code>, but this may be different in your deployment.</p>
|
||||
Edit the constants at the top of <code>org/humbug/jira/HumbugListener.groovy</code>
|
||||
and fill them with the appropriate values:
|
||||
<div class="codehilite"><pre><span class="n">String</span> <span class="n">humbugEmail</span> <span class="o">=</span> <span class="s2">"jira-notifications@example.com"</span>
|
||||
<div class="codehilite"><pre><span class="n">String</span> <span class="n">humbugEmail</span> <span class="o">=</span> <span class="s2">"jira-notifications-bot@example.com"</span>
|
||||
<span class="n">String</span> <span class="n">humbugAPIKey</span> <span class="o">=</span> <span class="s2">"0123456789abcdef0123456789abcdef"</span>
|
||||
<span class="n">String</span> <span class="n">humbugStream</span> <span class="o">=</span> <span class="s2">"JIRA"</span>
|
||||
<span class="n">String</span> <span class="n">issueBaseUrl</span> <span class="o">=</span> <span class="s2">"https://jira.COMPANY.com/browse/"</span>
|
||||
@ -318,8 +325,8 @@ following, to the stream <code>commits</code> with a subject that matches the re
|
||||
server:</p>
|
||||
|
||||
<div class="codehilite"><pre>[api]
|
||||
email=NAGIOS_EMAIL_ADDRESS
|
||||
key=NAGIOS_API_KEY
|
||||
email=NAGIOS_BOT_EMAIL_ADDRESS
|
||||
key=NAGIOS_BOT_API_KEY
|
||||
</pre></div>
|
||||
|
||||
<p>Copy <code>integrations/nagios/humbug_nagios.cfg</code>
|
||||
@ -438,7 +445,7 @@ key=NAGIOS_API_KEY
|
||||
notification messages to go (by default,
|
||||
stream <code>trac</code>):</p>
|
||||
|
||||
<div class="codehilite"><pre><span class="n">HUMBUG_USER</span> <span class="o">=</span> <span class="s">"trac-notifications@example.com"</span>
|
||||
<div class="codehilite"><pre><span class="n">HUMBUG_USER</span> <span class="o">=</span> <span class="s">"trac-notifications-bot@example.com"</span>
|
||||
<span class="n">HUMBUG_API_KEY</span> <span class="o">=</span> <span class="s">"0123456789abcdef0123456789abcdef"</span>
|
||||
<span class="n">STREAM_FOR_NOTIFICATIONS</span> <span class="o">=</span> <span class="s">"trac"</span>
|
||||
<span class="n">TRAC_BASE_TICKET_URL</span> <span class="o">=</span> <span class="s">"https://trac.example.com/ticket"</span></pre></div>
|
||||
|
||||
BIN
zephyr/static/images/api/bot-key.png
Normal file
BIN
zephyr/static/images/api/bot-key.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
BIN
zephyr/static/images/api/create-bot.png
Normal file
BIN
zephyr/static/images/api/create-bot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
Loading…
Reference in New Issue
Block a user