diff --git a/humbug/urls.py b/humbug/urls.py index 301b1c12cd..f03ada7063 100644 --- a/humbug/urls.py +++ b/humbug/urls.py @@ -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'), diff --git a/templates/confirmation/mituser_confirmation_email_body.txt b/templates/confirmation/mituser_confirmation_email_body.txt index fe6fe61c16..73d12c9e13 100644 --- a/templates/confirmation/mituser_confirmation_email_body.txt +++ b/templates/confirmation/mituser_confirmation_email_body.txt @@ -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 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 for an explanation. - - To set up Zephyr mirroring, run: - /mit/tabbott/humbug/zephyr_mirror.py - - 5) Visit the running app at: - - -If you're interested in mobile apps, we have early alphas available -as well. You can get the Android app at: - - -If you're interested in an iPhone version, join our waitlist here: - - -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, diff --git a/templates/zephyr/navbar.html b/templates/zephyr/navbar.html index a5efbb45d4..59b34c3c86 100644 --- a/templates/zephyr/navbar.html +++ b/templates/zephyr/navbar.html @@ -116,9 +116,13 @@ — retrying soon. Try now.
- Messages you send are not being mirrored to MIT zephyr - — Please check that you are still running the MIT - Zephyr mirroring bot. Check now + Messages you send are not being mirrored to MIT + zephyr — Please check + that you are running the Zephyr mirror + script. Once you've corrected this + issue, you can click + here to update this alert.
diff --git a/templates/zephyr/zephyr.html b/templates/zephyr/zephyr.html new file mode 100644 index 0000000000..c652ca7fd1 --- /dev/null +++ b/templates/zephyr/zephyr.html @@ -0,0 +1,92 @@ +{% extends "zephyr/portico.html" %} + +{# Zephyr Mirroring information page #} + +{% block customhead %} +{{ block.super }} + +{% endblock %} + +{% block portico_content %} +
+
+

Zephyr Mirroring for Humbug

+ +

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.

+ +

There are a few steps you need to take to setup Humbug for your +MIT Zephyr account.

+ +

First time setup

+
    +

  1. Create a password and activate your account using the URL in + your email.

    2. + +

  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.

    3. + +

  3. Copy over your Zephyr subscriptions

    + +

    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."

    + +

    If you would like to copy over all of your subscriptions, please + run the following command:
    + /mit/tabbott/humbug/zephyr_mirror.py --sync-subscriptions

    + +

    After running the script, please reload Humbug to allow the changes to + take effect.

    4. +
+ +

Long-term setup

+

On an Athena dialup + (linerva.mit.edu, + athena.dialup.mit.edu, + etc.), run the Zephyr mirroring script inside a screen + session.

+ +

IMPORTANT: You must keep the Zephyr mirroring 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 it is not running, only other Humbug users + will receive messages you send from Humbug!. The Humbug + web application will warn you if the Zephyr mirroring script is + not running.

+ +

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 for an explanation of how to do this.

+ +

To set up Zephyr mirroring, run:
+ /mit/tabbott/humbug/zephyr_mirror.py

+ +

Don't run multiple copies of the Zephyr mirroring script; + doing so will result in messages you sent being forwarded to + Zephyr twice.

+ +

Using the app

+

You can use the app by visiting https://humbughq.com

+ +

If you're interested in mobile apps, we have early alphas available +as well. You can get the + + Android app immediately or join + our waitlist for the iPhone version.

+ +

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.

+ +
+
+ +{% endblock %}