2013-02-06 20:25:04 +01:00
{% extends "zephyr/portico.html" %}
{# API information page #}
{% block portico_content %}
< div class = "row-fluid" >
< div class = "span8" >
2013-04-11 19:39:54 +02:00
< h1 > Integrations< / h1 >
< ul class = "breadcrumb" >
< li > < a href = "/" > Home< / a > < span class = "divider" > /< / span > < / li >
< li class = "active" > Integrations< / li >
< / ul >
2013-02-06 20:25:04 +01:00
2013-02-07 00:26:51 +01:00
< p > The English poet John Donne once wrote that "no man is an
island", and we feel the same about software. No system exists in
2013-07-10 22:31:14 +02:00
complete isolation, so we've made it easy for Zulip to connect to
2013-02-07 00:26:51 +01:00
the services you already use.< / p >
< p > With the integrations below, your team can stay up-to-date on
code changes, issue tickets, build system results, and much
more. So ask not for whom the notification tolls— it tolls
for thee! (Or for a team member of yours, I guess.)< / p >
2013-02-06 20:25:04 +01:00
< h3 > Getting started< / h3 >
2013-05-29 17:55:59 +02:00
< p > Many of these integrations are available in
2013-06-18 23:22:22 +02:00
our < a href = "/api" > API bindings< / a > . You may either send messages as
2013-05-29 17:55:59 +02:00
yourself or use a bot which you can create. Both options are managed at your
< a href = "/#settings" target = "_blank" > settings page< / a > .< / p >
2013-05-28 22:48:13 +02:00
2013-05-29 17:55:59 +02:00
< p > Create a bot:
< img class = "screenshot" src = "/static/images/api/create-bot.png" / > < / p >
2013-05-28 22:48:13 +02:00
2013-05-29 17:55:59 +02:00
< 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 >
2013-05-28 22:48:13 +02:00
< 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
trouble, don't hesitate
2013-07-11 16:45:53 +02:00
to < a href = "mailto:support@zulip.com?subject=Integration%20question" > email
2013-05-28 22:48:13 +02:00
us< / a > .< / p >
2013-02-06 20:25:04 +01:00
< h3 id = "services" > Services with integrations< / h3 >
< ul >
2013-04-01 23:57:42 +02:00
< li > < a href = "#beanstalk" > Beanstalk< / a > < / li >
2013-03-19 21:22:50 +01:00
< li > < a href = "#capistrano" > Capistrano< / a > < / li >
2013-02-06 20:25:04 +01:00
< li > < a href = "#git" > Git< / a > < / li >
< li > < a href = "#github" > GitHub< / a > < / li >
2013-02-10 00:35:06 +01:00
< li > < a href = "#jenkins" > Jenkins (or Hudson)< / a > < / li >
2013-03-29 22:57:10 +01:00
< li > < a href = "#jira" > Jira (hosted or v5.2+)< / a > < / li >
< li > < a href = "#jira-plugin" > Jira (locally installed)< / a > < / li >
2013-02-06 20:25:04 +01:00
< li > < a href = "#nagios" > Nagios< / a > < / li >
< li > < a href = "#pivotal" > Pivotal Tracker< / a > < / li >
< li > < a href = "#svn" > Subversion< / a > < / li >
< li > < a href = "#trac" > Trac< / a > < / li >
< li > < a href = "#trello" > Trello< / a > < / li >
2013-07-23 17:21:25 +02:00
{% comment %}
2013-02-06 20:25:04 +01:00
< li > < a href = "#twitter" > Twitter< / a > < / li >
{% endcomment %}
2013-07-11 16:45:53 +02:00
< li > ...and more coming soon! < a href = "mailto:support@zulip.com?subject=Integration%20request" > Email us< / a > with requests!< / li >
2013-02-06 20:25:04 +01:00
< / ul >
2013-04-01 23:57:42 +02:00
{#--------------------------------------------------------------------#}
< div id = "beanstalk" class = "integration" >
< h4 > Beanstalk< / h4 >
2013-07-10 22:31:14 +02:00
< p > Zulip supports both SVN and Git notifications from Beanstalk. In the beanstalk web application, go to the Setup page, and choose the Integrations tab.
2013-05-29 17:55:59 +02:00
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 > ,
2013-04-02 23:31:48 +02:00
as Beanstalk's website will incorrectly refuse to parse a username containing a < code > @< / code > .< / p >
2013-04-01 23:57:42 +02:00
2013-05-29 17:55:59 +02:00
< p > In the URL field, enter < code > https://bot_email:bot_api_key@humbughq.com/api/v1/external/beanstalk< / code > :< / p >
2013-04-01 23:57:42 +02:00
< img class = "screenshot" src = "/static/images/integrations/beanstalk/001.png" >
< p > < b > Congratulations! You're done!< / b > < br / > Whenever you do a
deployment, you'll get an automated notification that looks like
this:< / p >
< img class = "screenshot" src = "/static/images/integrations/beanstalk/002.png" >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-03-19 21:22:50 +01:00
{#--------------------------------------------------------------------#}
< div id = "capistrano" class = "integration" >
< h4 > Capistrano< / h4 >
< p > First, download and install our < a href = "/api" > Python
bindings and example scripts< / a > on your Capistrano server.
Once you've done that, you'll use the < code > humbug-send< / code >
utility to notify you when certain events happen.< / p >
2013-07-10 22:31:14 +02:00
< p > Here's some example code for sending a Zulip notification
2013-03-19 21:22:50 +01:00
after a deployment has completed:< / p >
2013-03-26 18:12:00 +01:00
< div class = "codehilite" > < pre > < span class = "n" > after< / span > < span class = "s1" > 'deploy'< / span > < span class = "p" > ,< / span > < span class = "s1" > 'notify:humbug'< / span >
2013-03-19 21:22:50 +01:00
< span class = "n" > namespace< / span > < span class = "ss" > :notify< / span > < span class = "k" > do< / span >
2013-07-10 22:31:14 +02:00
< span class = "n" > desc< / span > < span class = "s2" > "Post a message to Zulip that we've deployed"< / span >
2013-03-19 21:22:50 +01:00
< span class = "n" > task< / span > < span class = "ss" > :humbug< / span > < span class = "k" > do< / span >
2013-07-10 22:31:14 +02:00
< span class = "c1" > # this will post to Zulip as the user defined in
2013-05-29 17:55:59 +02:00
# ~/.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 >
2013-03-19 21:22:50 +01:00
< span class = "k" > end< / span >
< span class = "k" > end< / span >
< / pre > < / div >
< p > Some notes:< / p >
< ul >
2013-06-19 22:30:37 +02:00
< li > If you prefer not to use < code > --user< / code > and < code > --api-key< / code > above, you can fill out < code > ~/.humbugrc< / code > on your Capistrano
2013-05-29 17:55:59 +02:00
machine. For instructions on how to write that file, see < a href = "/api" > the API page< / a > .< / li >
2013-03-26 18:12:00 +01:00
< 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 >
2013-03-19 21:22:50 +01:00
< / ul >
2013-06-19 23:46:11 +02:00
< em > < / em >
2013-03-19 21:22:50 +01:00
< p > < b > Congratulations! You're done!< / b > < br / > Whenever you do a
deployment, you'll get an automated notification that looks like
this:< / p >
< img class = "screenshot" src = "/static/images/integrations/capistrano/001.png" >
< p > < small > Thanks to Wes of TurboVote for < a href = "https://gist.github.com/cap10morgan/5100822" > submitting this integration< / a > !< / small > < / p >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-02-15 23:01:55 +01:00
{#--------------------------------------------------------------------#}
< div id = "git" class = "integration" >
< h4 > Git< / h4 >
< p > First, download and install our < a href = "/api" > Python
bindings and example scripts< / a > on your Git server.< / p >
< p > Next, open < code > integrations/git/humbug_git_config.py< / code >
in your favorite editor, and change the following lines to
specify the email address and API key for your Git bot:< / p >
2013-05-29 17:55:59 +02:00
< div class = "codehilite" > < pre > < span class = "n" > HUMBUG_USER< / span > < span class = "o" > =< / span > < span class = "s" > "git-bot@example.com"< / span >
2013-02-15 23:01:55 +01:00
< 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
notifications and to what stream the notifications will be sent
by modifying the < code > commit_notice_destination< / code > function
in < code > humbug_git_config.py< / code > . By default, pushes to
the < code > master< / code > and < code > test-post-receive< / code >
branches will result in a notification to
stream < code > commits< / code > .< / p >
< p > Save < code > integrations/git/humbug_git_config.py< / code > to
the < code > .git/hooks< / code > directory of your git
repository.< / p >
< p > Symlink
< code > /usr/local/share/humbug/integrations/git/post-receive< / code >
into the < code > .git/hooks< / code > directory of your git repository.< / p >
< p > < b > Congratulations! You're done!< / b > < br / > Whenever you make
a push to the < code > master< / code > branch of your git repository
2013-07-10 22:31:14 +02:00
(or whatever you configured above), the Zulip git plugin will
2013-02-15 23:01:55 +01:00
send an automated notification that looks like this:< / p >
< img class = "screenshot" src = "/static/images/integrations/git/001.png" >
< p > < b > Testing< / b > < br / > You can test the plugin without changing
your < code > master< / code > branch by pushing to
the < code > test-post-receive< / code > branch.< / p >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-03-19 21:22:50 +01:00
{#--------------------------------------------------------------------#}
2013-02-06 20:25:04 +01:00
< div id = "github" class = "integration" >
< h4 > GitHub< / h4 >
< p > First, go to your repository page and click "Settings":< / p >
< img src = "/static/images/integrations/github/001.png" >
< p > From there, select "Service Hooks":< / p >
< img src = "/static/images/integrations/github/002.png" >
2013-02-06 23:12:25 +01:00
< p > Select "Humbug" from the list, fill in the API key and email
address for your bot, check the "active" checkbox, and pick
"Update settings":< / p >
2013-02-06 20:25:04 +01:00
< img src = "/static/images/integrations/github/003.png" >
< p > < b > Congratulations! You're done!< / b > < br / > When people push
to your repository, you'll see a commit message like the
2013-02-10 00:35:31 +01:00
following, to the stream < code > commits< / code > with a subject that matches the repository name (in this case "humbug-test"):< / p >
2013-02-06 23:12:25 +01:00
< img class = "screenshot" src = "/static/images/integrations/github/004.png" >
2013-02-06 20:25:04 +01:00
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-02-10 00:35:06 +01:00
{#--------------------------------------------------------------------#}
< div id = "jenkins" class = "integration" >
< h4 > Jenkins (or Hudson)< / h4 >
2013-02-06 22:31:26 +01:00
2013-04-18 21:56:41 +02:00
< p > < strong > Install the plugin< / strong > < br / >
Install the "Humbug" plugin by going to < code > Manage Jenkins
2013-04-05 00:15:31 +02:00
> Manage Plugins > Available< / code > , typing in "Humbug", and
clicking "Install without restart".< / p >
2013-02-10 00:35:06 +01:00
< img src = "/static/images/integrations/jenkins/001.png" >
2013-04-18 21:56:41 +02:00
< p > < strong > Configure the plugin< / strong > < br / > Once the plugin
is installed, configure it by going to < code > Manage Jenkins >
Configure System< / code > . Scroll to the section labeled "Humbug
Notification Settings", and specify your bot's email address,
API key, where you'd like your notification messages to go (we
recommend the stream < code > jenkins< / code > ), and whether you'd
like a notification on every build, or only when the build fails
(Smart Notification).< / p >
2013-02-10 00:35:06 +01:00
2013-04-18 21:59:00 +02:00
< img src = "/static/images/integrations/jenkins/002.png" >
2013-02-10 00:35:06 +01:00
2013-04-18 21:56:41 +02:00
< p > < strong > Configure a post-build action for your project< / strong > < br / >
Once you've done that, it's time to configure one of your
2013-07-10 22:31:14 +02:00
projects to use the Zulip notification plugin. From your
2013-04-18 21:56:41 +02:00
project page, click "Configure" on the left sidebar. Scroll to
the bottom until you find the section labeled "Post-build
Actions". Click the dropdown and select "Humbug
2013-02-10 00:35:06 +01:00
Notification". It should look as below. Then click "Save".< / p >
2013-04-18 21:59:00 +02:00
< img src = "/static/images/integrations/jenkins/003.png" >
2013-02-10 00:35:06 +01:00
< p > < b > Congratulations! You're done!< / b > < br / > When your builds
fail or succeed, you'll see a commit message like the following
with a subject that matches the project name (in this case
"Humbug Test"):< / p >
2013-04-18 21:59:00 +02:00
< img class = "screenshot" src = "/static/images/integrations/jenkins/004.png" >
< img class = "screenshot" src = "/static/images/integrations/jenkins/005.png" >
2013-04-05 00:15:31 +02:00
2013-04-18 21:56:41 +02:00
< p > < b > Troubleshooting< / b > < br / >
< ul >
< li > Did you set up a post-build action for your project?< / li >
< li > Does the stream you picked (e.g. < code > jenkins< / code > ) already exist? If not, add yourself to it and try again.< / li >
< li > Are your access key and email address correct? Test them using < a href = "/api" > our curl API< / a > .
2013-07-11 16:45:53 +02:00
< li > Still stuck? Email < a href = "mailto:support@zulip.com?subject=Jenkins" > support@zulip.com< / a > .< / li >
2013-06-19 23:46:11 +02:00
< / ul >
2013-02-10 00:35:06 +01:00
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-03-26 17:04:12 +01:00
{#--------------------------------------------------------------------#}
< div id = "jira" class = "integration" >
< h4 > JIRA< / h4 >
2013-03-27 22:47:54 +01:00
< h5 > Webhook mechanism< / h5 >
2013-04-30 23:41:46 +02:00
If you are running JIRA version 5.2 or greater, or if you are using the hosted JIRA provided
2013-07-10 22:31:14 +02:00
by Atlassian, you can use the built in web-hook support to connect to Zulip. If you are not
2013-03-27 22:47:54 +01:00
using the Atlassian-hosted JIRA, you may also use the < a href = "#jira-plugin" > Jira Plugin< / a >
mechanism that supports older versions of JIRA.
< p > In your JIRA administration control panel, go to the Webhooks page. If you are using the OnDemand
2013-03-29 22:57:10 +01:00
hosted JIRA, follow the instructions < a href = "https://developer.atlassian.com/display/JIRADEV/JIRA+Webhooks+Overview#JIRAWebhooksOverview-WhereistheJIRAAdministrationUIforwebhooks?" >
2013-06-19 23:46:11 +02:00
on the Atlassian wiki< / a > for locating the Webhook UI.
2013-03-27 22:47:54 +01:00
< / p >
2013-04-30 23:41:46 +02:00
< p > Give your new web hook a name, and for the URL provide the following:< / p >
< p >
2013-06-24 21:48:32 +02:00
< code > https://api.humbughq.com/v1/external/jira?api_key=abcdefgh& stream=jira< / code >
2013-03-27 22:47:54 +01:00
< / p >
2013-03-29 22:57:10 +01:00
2013-04-30 23:41:46 +02:00
< p > where < code > api_key< / code > is the API key of the user you
want updates to be sent as, and < code > stream< / code > is the stream name you want the notifications sent to.
2013-07-10 22:31:14 +02:00
< p > Next, go back to Zulip and set up a stream called "jira," if it does not already exist.
2013-04-30 23:41:46 +02:00
(If you prefer your JIRA notifications to go to a stream other than "jira," then change the URL above to match it.)< / p >
2013-03-29 22:57:10 +01:00
< p > < b > Congratulations! You're done!< / b > < br / >
2013-07-10 22:31:14 +02:00
Updates from JIRA will be sent to the Zulip stream you specified in the JIRA web-hook.
2013-03-29 22:57:10 +01:00
< img class = "screenshot" src = "/static/images/integrations/jira/001.png" >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
{#--------------------------------------------------------------------#}
< div id = "jira-plugin" class = "integration" >
< h4 > JIRA< / h4 >
< h5 > Plugin mechanism< / h5 >
First, download and install our < a href = "/api" > Python bindings and example scripts< / a > .
2013-03-26 17:04:12 +01:00
< p > < b > Plugin Installation< / b > < / p >
2013-03-29 22:57:10 +01:00
The JIRA integration plugin requires two JIRA plugins. Please install
2013-03-26 17:04:12 +01:00
the following plugins using the Universal Plugin Manager in your JIRA
2013-03-29 22:57:10 +01:00
installation:
2013-03-26 17:04:12 +01:00
< ul >
< li > < a href = "https://marketplace.atlassian.com/plugins/com.onresolve.jira.groovy.groovyrunner" > Script Runner Plugin< / a > < / li >
< li > < a href = "https://marketplace.atlassian.com/plugins/com.atlassian.jira.plugin.jirasslplugin" > SSL Plugin< / a > < / li >
< / ul >
< p > < b > SSL Setup< / b > < / p >
2013-07-10 22:31:14 +02:00
As Zulip is using a StartCOM SSL certificate that is not recognized by default in the Java installation shipped with JIRA,
2013-03-26 17:04:12 +01:00
you will need to tell JIRA about the certificate. Navigate to < code > Administration > System > Configure SSL< / code > and in
the < code > Import SSL Certificates< / code > field, enter < code > https://www.humbughq.com< / code > . After clicking < code > Save Certificates< / code > ,
follow the on-screen instructions and restart JIRA for it to recognize the proper certificates.
2013-07-10 22:31:14 +02:00
< p > < b > Zulip Integration< / b > < / p >
2013-03-26 23:12:31 +01:00
Copy the folder < code > integrations/jira/org/< / code > (from the tarball you downloaded above) to your JIRA < code > classes< / code > folder.
2013-06-19 23:46:11 +02:00
For self-contained JIRA installations, this will be < code > atlassian-jira/WEB-INF/classes/< / code > , but this may be different in your deployment.
2013-03-26 17:04:12 +01:00
Edit the constants at the top of < code > org/humbug/jira/HumbugListener.groovy< / code >
and fill them with the appropriate values:
2013-05-29 17:55:59 +02:00
< 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 >
2013-03-26 17:04:12 +01:00
< 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 >
2013-06-19 23:46:11 +02:00
< / pre > < / div >
2013-03-26 17:04:12 +01:00
< p > In the Administrators page, navigate to < code > Plugins > Other > Script Listeners< / code > . In the < code > Add Listener< / code > section, click on
2013-07-10 22:31:14 +02:00
the < code > Custom Listener< / code > option. Select the events you wish the Zulip integration to fire for, and the projects you wish Zulip to be notified for.
2013-03-26 17:04:12 +01:00
In the < code > Name of groovy class< / code > field, enter < code > org.humbug.jira.HumbugListener< / code > .
2013-07-10 22:31:14 +02:00
< p > Click < code > Add Listener< / code > , and JIRA will now notify your Zulip of changes to your issues!< / p >
2013-03-29 22:57:10 +01:00
< p > < b > Congratulations! You're done!< / b > < br / >
Updates from JIRA will be sent to the stream you've configured, as below.< / p >
2013-03-26 17:04:12 +01:00
< img class = "screenshot" src = "/static/images/integrations/jira/001.png" >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-02-13 22:19:08 +01:00
{#--------------------------------------------------------------------#}
< div id = "nagios" class = "integration" >
< h4 > Nagios< / h4 >
< p > First, download and install our < a href = "/api" > Python
bindings and example scripts< / a > on your Nagios server.< / p >
< p > Next, open < code > integrations/nagios/humbugrc.example< / code >
in your favorite editor, and change the following lines to
specify the email address and API key for your Nagios bot,
saving it to < code > /etc/nagios3/humbugrc< / code > on your Nagios
server:< / p >
< div class = "codehilite" > < pre > [api]
2013-05-29 17:55:59 +02:00
email=NAGIOS_BOT_EMAIL_ADDRESS
key=NAGIOS_BOT_API_KEY
2013-02-13 22:19:08 +01:00
< / pre > < / div >
< p > Copy < code > integrations/nagios/humbug_nagios.cfg< / code >
to < code > /etc/nagios3/conf.d< / code > on your Nagios server.< / p >
< p > Finally, add < code > humbug< / code > to the < code > members< / code >
list for one or more of the contact groups in the < code > CONTACT
GROUPS< / code > section
of < code > /etc/nagios3/conf.d/contacts.cfg< / code > , doing
something like:
< div class = "codehilite" > < pre > define contactgroup{
contactgroup_name admins
alias Nagios Administrators
members monitoring< span class = "na" > , humbug< / span >
}
< / pre > < / div >
Once you've done that, reload your Nagios configuration
2013-06-19 23:46:11 +02:00
using < code > /etc/init.d/nagios3 reload< / code > .
2013-02-13 22:19:08 +01:00
< p > < b > Congratulations! You're done!< / b > < br / > When your Nagios
system makes an alert, you'll see a message like the following,
to the stream < code > nagios< / code > (to change this, edit the
arguments to < code > nagios-notify-humbug< / code >
in < code > /etc/nagios3/conf.d/humbug_nagios.cfg< / code > ) with a
subject indicating the service with an issue:< / p >
< img class = "screenshot" src = "/static/images/integrations/nagios/001.png" >
< p > < b > Testing< / b > < br / > If you
have < a href = "http://nagios.sourceforge.net/docs/3_0/extcommands.html" > external
commands enabled in Nagios< / a > , you can generate a test notice
from your Nagios instance by visiting using the < code > Send
custom service notification< / code > command in
the < code > Service Commands< / code > section of any individual
service's page on your Nagios instance.< / p >
< p > < b > Troubleshooting< / b > < br / > You can confirm whether you've
2013-07-10 22:31:14 +02:00
correctly configured Nagios to run the Zulip plugin by looking
2013-02-13 22:19:08 +01:00
for < code > SERVICE NOTIFICATION< / code > lines mentioning humbug
in < code > /var/log/nagios3/nagios.log< / code > . You can confirm
2013-07-10 22:31:14 +02:00
whether you've configured the Zulip plugin code correctly by
2013-02-13 22:19:08 +01:00
running < code > /usr/local/share/humbug/integrations/nagios/nagios-notify-humbug< / code >
directly.< / p >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-04-18 17:53:45 +02:00
{#--------------------------------------------------------------------#}
< div id = "pivotal" class = "integration" >
< h4 > Pivotal Tracker< / h4 >
2013-07-10 22:31:14 +02:00
< p > Zulip supports Pivotal Tracker integration and can notify you of changes to the stories in your Pivotal Tracker project. In the Settings page
2013-04-18 17:53:45 +02:00
for your project, choose the Integrations tab. Scroll down to the < code > Activity Web Hook< / code > section, and enter the following url:< / p >
2013-06-24 21:48:32 +02:00
< p > < code > https://api.humbughq.com/v1/external/pivotal?api_key=abcdefgh& stream=pivotal< / code > < / p >
2013-04-18 17:53:45 +02:00
< p > where < code > api_key< / code > is the API key of the user you
want updates to be sent as, and < code > stream< / code > is the stream name you want the notifications sent to, and the stream must already exist.< / p >
2013-02-13 22:19:08 +01:00
2013-04-18 17:53:45 +02:00
< img class = "screenshot" src = "/static/images/integrations/pivotal/001.png" >
2013-07-10 22:31:14 +02:00
< p > < b > Congratulations! You're done!< / b > < br / > When you make changes in Pivotal Tracker they will be reflected in Zulip:
2013-04-18 17:53:45 +02:00
< img class = "screenshot" src = "/static/images/integrations/pivotal/002.png" >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-05-29 16:38:46 +02:00
{#--------------------------------------------------------------------#}
< div id = "svn" class = "integration" >
< h4 > Subversion< / h4 >
2013-07-10 22:31:14 +02:00
< p > It is easy to send Zulips on SVN commits, by configuring a post-commit
2013-05-29 16:38:46 +02:00
hook. To do this:< / p >
< ol >
< li > Download and install our < a href = "/api" > Python bindings< / a > on the
server where the SVN repository lives.< / li >
< li > Install < code > pysvn< / code > . On Linux, you can install
the < code > python-svn< / code > package. On other platforms, you can install
a binary or from source following
the < a href = "http://pysvn.tigris.org/project_downloads.html" > instructions
on the pysvn website< / a > .< / li >
< li > Copy < code > integrations/svn/humbug_svn_config.py< / code >
and < code > integrations/svn/post-commit< / code > from the API bindings
directory to the < code > hooks< / code > subdirectory of your SVN
repository.< / li >
< li > Open < code > humbug_svn_config.py< / code > in your favorite editor and
change the < code > HUMBUG_USER< / code > and < code > HUMBUG_API_KEY< / code >
variables at the top of the file to the credentials for the bot you'd
like to use for this integration.< / li >
< li > The default stream used by this post-commit hook
is < code > commits< / code > ; if you'd prefer a different stream, change it
now in < code > humbug_svn_config.py< / code > . Make sure that everyone
2013-07-10 22:31:14 +02:00
interested in getting these post-commit Zulips is subscribed to that
2013-05-29 16:38:46 +02:00
stream!< / li >
< / ol >
< p > < b > Congratulations! You're done!< / b > < br / > When you commit to this SVN
2013-07-10 22:31:14 +02:00
repository, the team can see these updates in real time in Zulip:< / p >
2013-05-29 16:38:46 +02:00
< img class = "screenshot" src = "/static/images/integrations/svn/001.png" >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-02-10 00:35:06 +01:00
{#--------------------------------------------------------------------#}
2013-02-06 22:31:26 +01:00
< div id = "trac" class = "integration" >
< h4 > Trac< / h4 >
2013-02-14 19:46:23 +01:00
< p > First, download and install our < a href = "/api" > Python
bindings and example scripts< / a > on your Trac server.< / p >
2013-02-06 22:31:26 +01:00
2013-02-14 19:46:23 +01:00
< p > Next, open < code > integrations/trac/humbug_trac_config.py< / code > in
2013-02-13 22:48:16 +01:00
your favorite editor, and change the following lines to specify
your bot's email address, API key, and where you'd like your
2013-02-06 22:31:26 +01:00
notification messages to go (by default,
stream < code > trac< / code > ):< / p >
2013-05-29 17:55:59 +02:00
< div class = "codehilite" > < pre > < span class = "n" > HUMBUG_USER< / span > < span class = "o" > =< / span > < span class = "s" > "trac-notifications-bot@example.com"< / span >
2013-02-06 22:31:26 +01:00
< 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 >
2013-02-14 19:46:23 +01:00
< p > Copy < code > integrations/trac/humbug_trac.py< / code >
and < code > integrations/trac/humbug_trac_config.py< / code > into
your Trac installation's < code > plugins/< / code >
subdirectory. Once you've done that, edit your Trac
installation's < code > conf/trac.ini< / code > to
add < code > humbug_trac< / code > to the < code > [components]< / code >
section, as follows:< / p >
2013-02-06 22:31:26 +01:00
< div class = "codehilite" > < pre > < span class = "k" > [components]< / span >
< span class = "na" > humbug_trac< / span > < span class = "o" > =< / span > < span class = "s" > enabled< / span > < / pre > < / div >
< p > You may then need to restart Trac (or Apache) so that Trac will load our plugin.< / p >
< p > < b > Congratulations! You're done!< / b > < br / > When people open
new tickets (or edit existing tickets), you'll see a message
like the following, to the stream < code > trac< / code > (or whatever
you configured above) with a subject that matches the ticket
name:< / p >
2013-02-06 23:12:25 +01:00
< img class = "screenshot" src = "/static/images/integrations/trac/001.png" >
2013-02-06 22:31:26 +01:00
2013-02-13 22:48:16 +01:00
< p > < b > Additional trac configuration< / b > < br / > After using the plugin
for a while, you may want to customize which changes to tickets
2013-07-10 22:31:14 +02:00
result in a Zulip notification using
2013-02-13 22:48:16 +01:00
the < code > TRAC_NOTIFY_FIELDS< / code > setting
in < code > humbug_trac_config.py< / code > .< / p >
2013-02-06 22:31:26 +01:00
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
2013-07-23 17:21:25 +02:00
{#--------------------------------------------------------------------#}
< div id = "trello" class = "integration" >
< h4 > Trello< / h4 >
< p > Download a copy
of < a href = "https://github.com/nathanlws/trello-to-zulip" > trello-to-zulip< / a >
and follow the instructions in < code > README.md< / code > . When you
make changes in Trello, they will be reflected in Zulip:
< / p >
< img class = "screenshot" src = "/static/images/integrations/trello/001.png" >
< p > < small > Thanks to Nathan from FoundationDB for < a href = "https://github.com/nathanlws/trello-to-zulip" > submitting this integration< / a > !< / small > < / p >
< p >
< a href = "#services" > ^ Back to top< / a >
< / p >
< / div >
{#--------------------------------------------------------------------#}
2013-06-19 23:46:11 +02:00
< / div >
2013-02-06 20:25:04 +01:00
< / div >
2013-04-02 20:01:23 +02:00
{% endblock %}
{% block customhead %}
{{ block.super }}
2013-02-06 20:25:04 +01:00
< script type = "text/javascript" >
$(function() {
$("a.title").addClass("show-integral");
2013-02-11 22:34:20 +01:00
$("a.title").prepend($("< span class = 'integral' > ∫< / span > "));
$("a.title").hover(function (e) {
$(".integral").css("display", "inline");
var width = $(".integral").width();
$("a.title").css("left", -1 * width);
},
function (e) {
$(".integral").css("display", "none");
$("a.title").css("left", 0);
});
2013-02-06 20:25:04 +01:00
});
< / script >
{% endblock %}
