mirror of https://github.com/zulip/zulip.git
Update documentation for MIT zephyr
(imported from commit 96cbd71e5d574bf8a0fb2e7fe17c75e4ec4ebfdb)
This commit is contained in:
Jeff Arnold
parent
611955e9fa
commit
2d0f8a9bba
|
|
@ -8,18 +8,11 @@
|
|||
<br /><br /> Retrying soon... <br /><br />
|
||||
</div>
|
||||
<div class="alert alert_sidebar alert-error home-error-bar" id="zephyr-mirror-error">
|
||||
<strong>Your Zephyr mirroring is not working.</strong>.
|
||||
There are two ways to fix this:
|
||||
|
||||
<ul>
|
||||
<li><a class="webathena_login">Grant Zulip permission to mirror
|
||||
the messages for you</a>. (Recommended)
|
||||
</li>
|
||||
|
||||
<li><a href="/zephyr#mirror" target="_blank">Run the
|
||||
Zephyr mirroring script yourself</a>
|
||||
</li>
|
||||
</ul>
|
||||
<strong>Your Zephyr mirror is not working.</strong>
|
||||
We recommend that you <a class="webathena_login">Give Zulip the ability to mirror
|
||||
the messages for you via WebAthena</a>. If you'd prefer, you can instead
|
||||
<a href="/zephyr-mirror" target="_blank">run the Zephyr mirror script yourself</a>
|
||||
in a screen session.
|
||||
</div>
|
||||
<div class="alert alert_sidebar alert-error home-error-bar" id="home-error"></div>
|
||||
<div class="alert alert_sidebar alert-error home-error-bar" id="reloading-application"></div>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,79 @@
|
|||
{% extends "zerver/portico.html" %}
|
||||
|
||||
{# Zephyr Mirroring information page #}
|
||||
|
||||
{% block portico_content %}
|
||||
<div class="row-fluid">
|
||||
<div class="span8">
|
||||
<h2>The Zephyr mirror script (not recommended)</h2>
|
||||
|
||||
<p>Webathena is the easiest way to use Zulip. With Webathena, you don't need
|
||||
to run any software in a screen session. Your Athena password never leaves
|
||||
your computer and the only access that any Zulip computer ever receives is the
|
||||
ability to send/receive zephyrs as you.</p>
|
||||
|
||||
<p>We recommend that you use Webathena instead of following these instructions.
|
||||
Please only follow these instructions if you know that you want to run the zephyr
|
||||
mirror script instead of using Webathena.</p>
|
||||
|
||||
<h3 id="mirror">Running the Zephyr mirror script</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 Zulip, and forwards messages you send in Zulip to
|
||||
Zephyr. <strong>If it is not running, only other Zulip users
|
||||
will receive messages you send from Zulip!</strong>. The Zulip
|
||||
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:</p>
|
||||
|
||||
<p><code>/mit/tabbott/humbug/zephyr_mirror.py</code></p>
|
||||
|
||||
<p>inside that screen session.</p>
|
||||
|
||||
<h4>Mirroring without a Barnowl session</h4>
|
||||
|
||||
<p>If you are not already running a screen/tmux for Barnowl, you
|
||||
can setup a screen session to run the Zephyr mirroring script by
|
||||
running the following on a dialup such
|
||||
as <a href="https://linerva.mit.edu">linerva.mit.edu</a>:</p>
|
||||
|
||||
<ol>
|
||||
<li><code>kinit -l7d && aklog</code></li>
|
||||
<li>(Type your password to create 7-day renewable Kerberos tickets)</li>
|
||||
<li><code>env ZEPHYR_SCREEN_CLIENT=/mit/tabbott/humbug/zephyr_mirror.py
|
||||
SCREEN_SESSION_NAME=humbug athrun kchen owl-screen
|
||||
</code></li>
|
||||
</ol>
|
||||
|
||||
<p>This will run the Zephyr Mirroring script inside a screen
|
||||
session, and use `/mit/kchen/bin/cont-renew-notify` to continually
|
||||
renew your Kerberos tickets for up to a week; each week, it will
|
||||
send you a Zephyr/Zulip letting you know that you need to renew
|
||||
your tickets. To do so, login to the server that you setup the
|
||||
screen session on and use the following procedure:</p>
|
||||
|
||||
<ol>
|
||||
<li>Run <code>screen -x humbug</code> to connect to the mirroring
|
||||
screen session created above.</li>
|
||||
<li>The first time, you'll need to type <code>ctrl-a c</code> to switch to a new terminal in your screen session.</li>
|
||||
<li><code>kinit -l7d && aklog</code></li>
|
||||
<li>(Type type your password to renew your Kerberos tickets).</li>
|
||||
</ol>
|
||||
|
||||
<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>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{% endblock %}
|
||||
|
|
@ -5,106 +5,41 @@
|
|||
{% block portico_content %}
|
||||
<div class="row-fluid">
|
||||
<div class="span8">
|
||||
<h2>Zephyr Mirroring for Zulip</h2>
|
||||
<h2>Zulip for MIT Zephyr</h2>
|
||||
|
||||
<p>Thanks for giving Zulip a try! This page describes how to use
|
||||
Zulip with MIT Zephyr; if you're not a current Zephyr user,
|
||||
you probably want to visit the main Zulip website.</p>
|
||||
|
||||
<p>There are a few steps you need to take to setup Zulip for your
|
||||
MIT Zephyr account.</p>
|
||||
<p>If you have an MIT Athena account, you can start using Zulip for Zephyr in a couple of minutes.</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>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> NOTE: Zulip does not fully support the equivalent of Barnowl
|
||||
filters. If you have too many subscriptions (you know who you
|
||||
are), you may want to either manually subscribe to just your main
|
||||
barnowl view or make extensive use of the "Not in home view"
|
||||
option on streams. You can add or remove subscriptions from the
|
||||
Zulip app (or your Zulip home view) by clicking the gear in the
|
||||
upper right-hand corner and then selecting "Streams."</p>
|
||||
<li><p>Activate your account here: <a href="https://zephyr.zulip.com/register/">https://zephyr.zulip.com/register/</a></p></li>
|
||||
<li><p>Log in to Zulip here: <a href="https://zephyr.zulip.com">https://zephyr.zulip.com</a></p></li>
|
||||
<li><p>(Optional) Get the Zulip desktop and/or mobile apps here: <a href="https://zulip.com/apps">https://zulip.com/apps</a></p></li>
|
||||
</ol>
|
||||
|
||||
<h3 id="mirror">Running the Zephyr Mirror script</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>
|
||||
<h3>You're done!</h3>
|
||||
<p>If you have any questions, please contact us using the "Send feedback" button in Zulip or e-mail us at
|
||||
<a href="mailto:support@zulip.com">support@zulip.com</a><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 Zulip, and forwards messages you send in Zulip to
|
||||
Zephyr. <strong>If it is not running, only other Zulip users
|
||||
will receive messages you send from Zulip!</strong>. The Zulip
|
||||
web application will warn you if the Zephyr mirroring script is
|
||||
not running.</p>
|
||||
<h3>If you want to automatically transfer your existing Zephyr subscriptions</h3>
|
||||
|
||||
<p>If you already have Barnowl running in screen/tmux somewhere,
|
||||
you can just run:</p>
|
||||
<ol>
|
||||
<li><p>Get your Zulip API key from the Zulip "Settings" panel and put it in a file in your
|
||||
Athena home directory called <code>~/Private/.humbug-api-key</code>.</p></li>
|
||||
|
||||
<p><code>/mit/tabbott/humbug/zephyr_mirror.py</code></p>
|
||||
<li><p>Run the following command to copy over all of your subscriptions:<br />
|
||||
<code>/mit/tabbott/humbug/zephyr_mirror.py --sync-subscriptions</code></p>
|
||||
|
||||
<p>inside that screen session.</p>
|
||||
<p> NOTE: Zulip supports several ways to control what messages you want to read
|
||||
right now, but Zulip does not yet have a direct equivalent to Barnowl filters.
|
||||
If you have more subscriptions than you generally read, we recommend that you use
|
||||
Zulip's "Hide from home view" option to hide those subscriptions from your
|
||||
home view that you less commonly read. You can still easily access those streams
|
||||
from Zulip when you want to read them. You can control your subscriptions
|
||||
and what's in your home view by clicking the gear in the upper right-hand corner
|
||||
and then selecting "Streams".</p>
|
||||
</ol>
|
||||
|
||||
<h4>Mirroring without a Barnowl session</h4>
|
||||
|
||||
<p>If you are not already running a screen/tmux for Barnowl, you
|
||||
can setup a screen session to run the Zephyr mirroring script by
|
||||
running the following on a dialup such
|
||||
as <a href="https://linerva.mit.edu">linerva.mit.edu</a>:</p>
|
||||
|
||||
<ol>
|
||||
<li><code>kinit -l7d && aklog</code></li>
|
||||
<li>(Type your password to create 7-day renewable Kerberos tickets)</li>
|
||||
<li><code>env ZEPHYR_SCREEN_CLIENT=/mit/tabbott/humbug/zephyr_mirror.py
|
||||
SCREEN_SESSION_NAME=humbug athrun kchen owl-screen
|
||||
</code></li>
|
||||
</ol>
|
||||
|
||||
<p>This will run the Zephyr Mirroring script inside a screen
|
||||
session, and use `/mit/kchen/bin/cont-renew-notify` to continually
|
||||
renew your Kerberos tickets for up to a week; each week, it will
|
||||
send you a Zephyr/Zulip letting you know that you need to renew
|
||||
your tickets. To do so, login to the server that you setup the
|
||||
screen session on and use the following procedure:</p>
|
||||
|
||||
<ol>
|
||||
<li>Run <code>screen -x humbug</code> to connect to the mirroring
|
||||
screen session created above.</li>
|
||||
<li>The first time, you'll need to type <code>ctrl-a c</code> to switch to a new terminal in your screen session.</li>
|
||||
<li><code>kinit -l7d && aklog</code></li>
|
||||
<li>(Type type your password to renew your Kerberos tickets).</li>
|
||||
</ol>
|
||||
|
||||
<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 always use our webapp by
|
||||
visiting <a href="https://zulip.com/">https://zulip.com</a>,
|
||||
though you might also like to try our <a href="/apps">desktop and
|
||||
mobile apps.</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>
|
||||
</div>
|
||||
|
||||
{% endblock %}
|
||||
|
|
|
|||
|
|
@ -78,6 +78,7 @@ urlpatterns = patterns('',
|
|||
url(r'^api/endpoints/$', 'zerver.views.api_endpoint_docs'),
|
||||
url(r'^integrations/$', TemplateView.as_view(template_name='zerver/integrations.html')),
|
||||
url(r'^zephyr/$', TemplateView.as_view(template_name='zerver/zephyr.html')),
|
||||
url(r'^zephyr-mirror/$', TemplateView.as_view(template_name='zerver/zephyr-mirror.html')),
|
||||
url(r'^apps$', TemplateView.as_view(template_name='zerver/apps.html')),
|
||||
|
||||
# Job postings
|
||||
|
|
|
|||
Loading…
Reference in New Issue