mirror of https://github.com/zulip/zulip.git
Move MIT Zephyr setup instructions to humbughq.com/zephyr.
This makes it possible to point users back at the instructions they followed originally in the event that their Zephyr mirroring bot has died. (imported from commit 24ab2dc0df3dc88f8155d58761a89fe44c111fd9)
This commit is contained in:
Tim Abbott
parent
968d1cd9ee
commit
861cb405f6
|
|
@ -47,6 +47,7 @@ urlpatterns = patterns('',
|
|||
# API and integrations documentation
|
||||
url(r'^api$', 'django.views.generic.simple.direct_to_template', {'template': 'zephyr/api.html'}),
|
||||
url(r'^integrations$', 'django.views.generic.simple.direct_to_template', {'template': 'zephyr/integrations.html'}),
|
||||
url(r'^zephyr$', 'django.views.generic.simple.direct_to_template', {'template': 'zephyr/zephyr.html'}),
|
||||
|
||||
# These are json format views used by the web client. They require a logged in browser.
|
||||
url(r'^json/get_updates$', 'zephyr.tornadoviews.json_get_updates'),
|
||||
|
|
|
|||
|
|
@ -8,51 +8,12 @@ MIT Zephyr account.
|
|||
1) Create a password and activate your account:
|
||||
<{{ activate_url }}>
|
||||
|
||||
2) Get your API key from the "Settings" panel and put it in a file in your
|
||||
Athena home directory called ~/Private/.humbug-api-key .
|
||||
2) Follow the instructions on <https://humbughq.com/zephyr> to setup
|
||||
the Zephyr mirroring system.
|
||||
|
||||
3) Copy over your Zephyr subscriptions
|
||||
|
||||
NOTE: Humbug does not currently support filters; everything you subscribe
|
||||
to will be in your default view. If you have too many subscriptions (you
|
||||
know who you are), you may want to manually subscribe to just your main
|
||||
view. You can add or remove subscriptions from the Humbug app by clicking
|
||||
the gear in the upper right-hand corner and then selecting "Streams."
|
||||
|
||||
If you would like to copy over all of your subscriptions, please run the
|
||||
command below:
|
||||
/mit/tabbott/humbug/zephyr_mirror.py --sync-subscriptions
|
||||
|
||||
After running the script, please reload Humbug to allow the changes to
|
||||
take effect.
|
||||
|
||||
4) On an Athena dialup (linerva.mit.edu, scrubbing-bubbles.mit.edu, etc),
|
||||
run the Zephyr mirroring script.
|
||||
|
||||
IMPORTANT: You must keep this script always running in a session
|
||||
with unexpired Kerberos tickets. The script forwards personals
|
||||
you receive on Zephyr to Humbug, and forwards messages you send in
|
||||
Humbug to Zephyr.
|
||||
|
||||
If you already have Barnowl running in screen/tmux somewhere, you can just
|
||||
run the command below inside that session. If not, see "Running Barnowl in
|
||||
Screen" at <http://sipb.mit.edu/doc/zephyr/> for an explanation.
|
||||
|
||||
To set up Zephyr mirroring, run:
|
||||
/mit/tabbott/humbug/zephyr_mirror.py
|
||||
|
||||
5) Visit the running app at:
|
||||
<https://humbughq.com/>
|
||||
|
||||
If you're interested in mobile apps, we have early alphas available
|
||||
as well. You can get the Android app at:
|
||||
<https://play.google.com/store/apps/details?id=com.humbughq.mobile>
|
||||
|
||||
If you're interested in an iPhone version, join our waitlist here:
|
||||
<http://goo.gl/ROOVQ>
|
||||
|
||||
Feel free to send us a message via the Feedback button from within the
|
||||
app if you have any questions or encounter any problems.
|
||||
Feel free to send us a message via the Feedback button under the gear
|
||||
tab within the app if you have any questions or encounter any
|
||||
problems.
|
||||
|
||||
|
||||
Cheers,
|
||||
|
|
|
|||
|
|
@ -116,9 +116,13 @@
|
|||
— retrying soon. <a class="cursor_pointer" onclick="restart_get_updates({dont_block: true});">Try now</a>.
|
||||
</div>
|
||||
<div class="alert alert_sidebar alert-error home-error-bar" id="zephyr-mirror-error">
|
||||
<strong>Messages you send are not being mirrored to MIT zephyr</strong>
|
||||
— Please check that you are still running the MIT
|
||||
Zephyr mirroring bot. <a class="cursor_pointer" onclick="restart_get_updates({dont_block: true});">Check now</a>
|
||||
<strong>Messages you send are not being mirrored to MIT
|
||||
zephyr</strong> — Please check
|
||||
that <a href="/zephyr">you are running the Zephyr mirror
|
||||
script</a>. Once you've corrected this
|
||||
issue, you can <a class="cursor_pointer"
|
||||
onclick="restart_get_updates({dont_block: true});">click
|
||||
here</a> to update this alert.
|
||||
</div>
|
||||
<div class="alert alert_sidebar alert-error home-error-bar" id="reloading-application">
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,92 @@
|
|||
{% extends "zephyr/portico.html" %}
|
||||
|
||||
{# Zephyr Mirroring information page #}
|
||||
|
||||
{% block customhead %}
|
||||
{{ block.super }}
|
||||
<link rel="stylesheet" href="/static/styles/pygments.css" />
|
||||
{% endblock %}
|
||||
|
||||
{% block portico_content %}
|
||||
<div class="row-fluid">
|
||||
<div class="span8">
|
||||
<h2>Zephyr Mirroring for Humbug</h2>
|
||||
|
||||
<p>Thanks for giving Humbug a try! This page describes how to use
|
||||
Humbug as to use MIT Zephyr; if you're not a current Zephyr user,
|
||||
you probably want to visit the main Humbug website.</p>
|
||||
|
||||
<p>There are a few steps you need to take to setup Humbug for your
|
||||
MIT Zephyr account.</p>
|
||||
|
||||
<h3>First time setup</h3>
|
||||
<ol>
|
||||
<li><p>Create a password and activate your account using the URL in
|
||||
your email.</p></li>
|
||||
|
||||
<li><p>Get your API key from the "Settings" panel and put it in a file in your
|
||||
Athena home directory called <code>~/Private/.humbug-api-key</code>.</p></li>
|
||||
|
||||
<li><p>Copy over your Zephyr subscriptions</p>
|
||||
|
||||
<p> NOTE: Humbug does not currently support the equivalent of
|
||||
Barnowl filters; everything you subscribe to will be in your
|
||||
default view. If you have too many subscriptions (you know who you
|
||||
are), you may want to manually subscribe to just your main
|
||||
view. You can add or remove subscriptions from the Humbug app by
|
||||
clicking the gear in the upper right-hand corner and then
|
||||
selecting "Streams."</p>
|
||||
|
||||
<p>If you would like to copy over all of your subscriptions, please
|
||||
run the following command:<br />
|
||||
<code>/mit/tabbott/humbug/zephyr_mirror.py --sync-subscriptions</code></p>
|
||||
|
||||
<p>After running the script, please reload Humbug to allow the changes to
|
||||
take effect.</p></li>
|
||||
</ol>
|
||||
|
||||
<h3>Long-term setup</h3>
|
||||
<p>On an Athena dialup
|
||||
(<a href="https://linerva.mit.edu">linerva.mit.edu</a>,
|
||||
<a href="https://athena.dialup.mit.edu">athena.dialup.mit.edu</a>,
|
||||
etc.), run the Zephyr mirroring script inside a screen
|
||||
session.</p>
|
||||
|
||||
<p><strong>IMPORTANT: You must keep the Zephyr mirroring script
|
||||
always running in a session with unexpired Kerberos
|
||||
tickets.</strong> The script forwards personals you receive on
|
||||
Zephyr to Humbug, and forwards messages you send in Humbug to
|
||||
Zephyr. <strong>If it is not running, only other Humbug users
|
||||
will receive messages you send from Humbug!</strong>. The Humbug
|
||||
web application will warn you if the Zephyr mirroring script is
|
||||
not running.</p>
|
||||
|
||||
<p>If you already have Barnowl running in screen/tmux somewhere,
|
||||
you can just run the command below inside that session. If not,
|
||||
see <a href="https://sipb.mit.edu/doc/zephyr/">Running Barnowl in
|
||||
Screen</a> for an explanation of how to do this.<p>
|
||||
|
||||
<p>To set up Zephyr mirroring, run: <br />
|
||||
<code>/mit/tabbott/humbug/zephyr_mirror.py</code></p>
|
||||
|
||||
<p>Don't run multiple copies of the Zephyr mirroring script;
|
||||
doing so will result in messages you sent being forwarded to
|
||||
Zephyr twice.</p>
|
||||
|
||||
<h3>Using the app</h3>
|
||||
<p>You can use the app by visiting <a href="https://humbughq.com/">https://humbughq.com</a></p>
|
||||
|
||||
<p>If you're interested in mobile apps, we have early alphas available
|
||||
as well. You can get the
|
||||
<a href="https://play.google.com/store/apps/details?id=com.humbughq.mobile">
|
||||
Android app</a> immediately or <a href="http://goo.gl/ROOVQ">join
|
||||
our waitlist for the iPhone version</a>.</p>
|
||||
|
||||
<p>Feel free to send us a message via the Feedback button under the
|
||||
gear tab within the app if you have any questions or encounter any
|
||||
problems.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{% endblock %}
|
||||
Loading…
Reference in New Issue