[tor-commits] [nyx/master] Fill in FAQ content
atagar at torproject.org
atagar at torproject.org
Sat Aug 5 01:18:26 UTC 2017
commit 6f94c1178134a68da51d8165d5d81b4dfe61e2de
Author: Damian Johnson <atagar at torproject.org>
Date: Sat Jul 29 13:36:04 2017 -0700
Fill in FAQ content
Styling isn't as I'd like yet. Just copying over the FAQ entries from our
Sphinx page.
---
web/images/faq/acs_failure.png | Bin 0 -> 161127 bytes
web/images/faq/resources/vidalia_full.png | Bin 0 -> 44187 bytes
web/images/faq/vidalia.jpg | Bin 0 -> 13695 bytes
web/images/screenshots/acs_failure.png | Bin 0 -> 405426 bytes
web/index.html | 150 +++++++++++++++++++++++++++++-
5 files changed, 149 insertions(+), 1 deletion(-)
diff --git a/web/images/faq/acs_failure.png b/web/images/faq/acs_failure.png
new file mode 100644
index 0000000..cd44aa8
Binary files /dev/null and b/web/images/faq/acs_failure.png differ
diff --git a/web/images/faq/resources/vidalia_full.png b/web/images/faq/resources/vidalia_full.png
new file mode 100644
index 0000000..3e13855
Binary files /dev/null and b/web/images/faq/resources/vidalia_full.png differ
diff --git a/web/images/faq/vidalia.jpg b/web/images/faq/vidalia.jpg
new file mode 100644
index 0000000..2350272
Binary files /dev/null and b/web/images/faq/vidalia.jpg differ
diff --git a/web/images/screenshots/acs_failure.png b/web/images/screenshots/acs_failure.png
new file mode 100644
index 0000000..48aff76
Binary files /dev/null and b/web/images/screenshots/acs_failure.png differ
diff --git a/web/index.html b/web/index.html
index 5da37bf..b73fc4c 100644
--- a/web/index.html
+++ b/web/index.html
@@ -89,7 +89,6 @@
<div id="faq" class="page">
<div class="section"></div>
<a href="#faq" class="section-title">Fact & Question</a>
-
<br /><br />
<div class="question" id="what_is_nyx">
@@ -108,6 +107,155 @@
<p style="min-height: 340px">Simple - because the <a href="https://en.wikipedia.org/wiki/Nyx">Greek goddess of night</a> is short and memorable. Terminal applications are handiest when they're brief and easy to type. Top, ssh, scp - anything longer is just begging to be aliased down.</p>
</div>
</div>
+
+ <div class="question" id="does_nyx_have_any_dependencies">
+ <span>Does Nyx have any dependencies?</span>
+ <div class="answer">
+ <p><b>Yes</b>, Nyx requires <a href="https://stem.torproject.org/>">Stem 1.4.5 or later</a>.
+ </div>
+ </div>
+
+ <div class="question" id="what_python_versions_is_nyx_compatible_with">
+ <span>What Python versions is Nyx compatible with?</span>
+ <div class="answer">
+ <p>Nyx works with <b>Python 2.6 and greater</b>, including the Python 3.x series.</p>
+ </div>
+ </div>
+
+ <div class="question" id="are_there_any_other_tor_uis">
+ <span>Are there any other user interfaces for Tor?</span>
+ <div class="answer">
+ <img src="images/faq/vidalia.jpg" alt="vidalia" />
+ <p>Yes, though sadly this isn't a space that gets much attention.</p>
+ <p>For years <a href="https://en.wikipedia.org/wiki/Vidalia_%28software%29">Vidalia</a> was the default interface of Tor until it was replaced in 2013 by <a href="https://www.torproject.org/projects/torbrowser.html.en">Tor Browser</a>. Vidalia includes a launcher, settings editor, map, and more. <a href="https://sourceforge.net/projects/tork/">TorK</a> is similar, providing connection information as well but never reached the same level of prominence. Both interfaces are now unmaintained.</p>
+ <p>Smaller widgets include...</p>
+
+ <ul>
+ <li><a href="https://gitorious.org/syboa/syboa">Syboa</a> - General interface</li>
+ <li><a href="https://github.com/neelchauhan/OnionLauncher">OnionLauncher</a> - Tor launcher</li>
+ <li><a href="https://github.com/neelchauhan/TorNova">TorNova</a> - Tor launcher</li>
+ <li><a href="https://github.com/skyguy/onionview">OnionView</a> - Circuit information</li>
+ <li><a href="https://git-tails.immerda.ch/onioncircuits/">OnionCircuits</a> - Circuit information</li>
+ <li><a href="https://github.com/Yawning/or-applet">or-applet</a> - Circuit information</li>
+ </ul>
+
+ <p>If I missed any then please <a href="https://www.atagar.com/contact/">let me know</a>!</p>
+ </div>
+ </div>
+
+ <div class="question" id="what_license_is_nyx_under">
+ <span>What license is Nyx under?</span>
+ <div class="answer">
+ <p>Nyx is under the <a href="https://www.gnu.org/licenses/gpl">GPLv3</a>.</p>
+ </div>
+ </div>
+
+ <div class="section"></div>
+ <a href="#usage" class="section-title">Usage</a>
+ <br /><br />
+
+ <div class="question" id="will_exits_include_user_traffic">
+ <span>When running an exit will I see people's traffic?</span>
+ <div class="answer">
+ <p><b>No</b>. Potential client and exit connections are scrubbed of sensitive information. Be aware that it's highly discouraged (and possibly illegal) for relay operators to view this data, so please don't.</p>
+ </div>
+ </div>
+
+ <div class="question" id="is_it_harmful_to_share_data">
+ <span>Is it harmful to share the information provided by Nyx?</span>
+ <div class="answer">
+ <p><b>Not really</b>, but show some moderation. Screenshots of Nyx are unlikely to do any harm but try to avoid exposing data en mass.</p>
+ </div>
+ </div>
+
+ <div class="question" id="can_nyx_leak_data">
+ <span>Is there any chance that nyx will leak data?</span>
+ <div class="answer">
+ <p><b>No</b>. Nyx is a completely passive listener, fetching all information from either Tor or the local system.</p>
+ </div>
+ </div>
+
+ <div class="question" id="why_dont_i_see_the_bandwith_graph">
+ <span>Why don't I see the bandwidth graph?</span>
+ <div class="answer">
+ <p>On some terminals such as Gentoo screen sessions appear to have a bug where highlighted spaces aren't shown. Try running...</p>
+ <pre>export TERM="rxvt-unicode"</pre>
+ </div>
+ </div>
+
+ <div class="question" id="why_are_borders_broken">
+ <span>Why are there borders like 'mwqqqqqqqqj'?</span>
+ <div class="answer">
+ <p>If you're getting something that looks like...</p>
+ <a href="images/screenshots/acs_failure.png"><img src="images/faq/acs_failure.png" alt="acs display failure" /></a>
+ <p>... you are encountering a terminal bug where alternate character support (ACS) <a href="http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing">is unavailable</a>.</p>
+ <p>Unfortunately there doesn't seem to be a way for Nyx to automatically detect or correct this. To work around this you can set the following in your nyxrc to not use ACS borders...</p>
+ <pre>features.acsSupport false</pre>
+ </div>
+ </div>
+
+ <div class="question" id="why_are_relay_details_missing">
+ <span>Why are relay details for connections missing?</span>
+ <div class="answer">
+ <p>Relays publish information about themselves in documents called <i>descriptors</i>. These documents are downloaded by Tor. New documents available on an hourly basis but Tor will only download them if it needs them, so the descriptors you have may be older.</p>
+ <p>Nyx's connections page use these descriptors to enrich connection information with data about the relay you're connected with. If Tor doesn't have this information the data may be stale or missing.</p>
+ <p><b>This is fine.</b> Descriptor information we use changes infrequently so even if they're a few hours old it won't matter. However, if you really need up-to-date information you can add the following to your torrc...</p>
+
+ <pre># download new descriptors even if our cache is still valid
+
+FetchDirInfoEarly 1
+FetchDirInfoExtraEarly 1
+FetchUselessDescriptors 1</pre>
+ </div>
+ </div>
+
+ <div class="section"></div>
+ <a href="#development" class="section-title">Development</a>
+ <br /><br />
+
+ <div class="question" id="how_do_i_get_started">
+ <span>How do I get started?</span>
+ <div class="answer">
+ <p>The best way of getting involved with any project is to jump right in! Our <a href="http://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">bug tracker</a> lists several development tasks. In particular look for the 'easy' keyword when getting started. If you have any questions then I'm always more than happy to help! I'm <b>atagar</b> on <a href="http://www.oftc.net/">oftc</a> and also available <a href="https://www.atagar.com/contact/">via email</a>.</p>
+ <p>To start hacking on Nyx please do the following and don't hesitate to let me know if you get stuck or would like to discuss anything!</p>
+
+ <ol>
+ <li>Clone our <a href="http://git-scm.com/">git</a> repository: <b>git clone https://git.torproject.org/nyx.git</b></li>
+ <li>Install the development version of <a href="https://stem.torproject.org/">Stem</a>: <b>git clone https://git.torproject.org/stem.git; cd stem; sudo python setup.py install</b>.</li>
+#. Get our test dependencies: **sudo pip install mock pep8 pyflakes**.
+#. Find a `bug or feature <https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs>`_ that sounds interesting.
+#. When you have something that you would like to contribute back do the following...
+
+ * If you don't already have a publicly accessible Nyx repository then set one up. `GitHub <https://github.com/>`_ in particular is great for this.
+ * File a `trac ticket <https://trac.torproject.org/projects/tor/newticket>`_, the only fields you'll need are...
+
+ * Summary: short description of your change
+ * Description: longer description and a link to your repository with either the git commits or branch that has your change
+ * Type: 'defect' if this is a bug fix and 'enhancement' otherwise
+ * Priority: rough guess at the priority of your change
+ * Component: Core Tor / Nyx
+
+ * I'll review the change and give suggestions. When we're both happy with it I'll push your change to the official repository.
+ </div>
+ </div>
+
+ <div class="question" id="how_do_i_run_the_tests">
+ <span>How do I run the tests?</span>
+ <div class="answer">
+ <p>Nyx has unit tests, including tests that exercise our curses functionality. When you run the tests you may notice your console flicker as these are exercised.</p>
+ <p>If you have them installed we run <a href="https://launchpad.net/pyflakes">pyflakes</a> to do static error checking and <a href="http://pycodestyle.readthedocs.org/en/latest/">pycodestyle</a> for style checking as part of our tests.</p>
+ <p>Tests are run with...</p>
+ <pre>% run_tests.py</pre>
+ </div>
+ </div>
+
+ <div class="question" id="what_is_the_copyright_for_patches">
+ <span>What is the copyright for patches?</span>
+ <div class="answer">
+ <p>Nyx is under the <a href="https://www.gnu.org/licenses/gpl">GPLv3</a> which is a fine license, but poses a bit of a problem for sharing code with our other projects (which are mostly BSD). To share code without needing to hunt down prior contributors we need Tor to have the copyright for the whole Nyx codebase. Presently the copyright of Nyx is jointly held by its main author (<a href="https://www.atagar.com/">Damian</a>) and the <a href="https://www.torproject.org/">Tor Project</a>.
+ <p>If you submit a substantial patch I'll ask if you're fine with it being in the public domain. This would mean that there are no legal restrictions for using your contribution, and hence won't pose a problem if we reuse Nyx code in other projects.</p>
+ </div>
+ </div>
</div>
<div id="download" class="page">
More information about the tor-commits
mailing list