Browse code

Adding 'Relay Web Status Panel'

Adding a project I'm interested in mentoring this summer.

Damian Johnson authored on05/02/2014 18:01:31
Showing1 changed files
... ...
@@ -629,6 +629,7 @@ meetings around the world.</li>
629 629
     <p>
630 630
     <b>Project Ideas:</b><br />
631 631
     <i><a href="#txtorcon-stemIntegration">Txtorcon/Stem Integration</a></i><br />
632
+    <i><a href="#relayWebPanel">Relay Web Status Panel </a></i><br />
632 633
     </p>
633 634
 
634 635
     <a id="project-txtorcon"></a>
... ...
@@ -917,6 +918,53 @@ meetings around the world.</li>
917 918
     bonus points if it's Twisted.</p>
918 919
     </li>
919 920
 
921
+    <a id="relayWebPanel"></a>
922
+    <li>
923
+    <b>Relay Web Status Panel</b>
924
+    <br>
925
+    Effort Level: <i>Medium</i>
926
+    <br>
927
+    Skill Level: <i>Medium</i>
928
+    <br>
929
+    Likely Mentors: <i>Damian (atagar)</i>
930
+    <p>
931
+    Relay operators presently have a couple options for monitoring the status
932
+    of their relay: <a
933
+    href="https://www.torproject.org/getinvolved/volunteer.html.en#project-vidalia">Vidalia</a>
934
+    which is a gui and <a href="https://www.atagar.com/arm/">arm</a> which uses
935
+    curses. This project would be to make a new kind of monitor specifically
936
+    for relay operators that provides a status dashboard site on localhost.
937
+    </p>
938
+    <p>
939
+    The interface will likely <a
940
+    href="https://www.atagar.com/arm/screenshots.php">borrow heavily from
941
+    arm</a>, except of course in areas where we can improve upon it. Two
942
+    important design constraints is that a localhost controller provides a
943
+    bigger attack surface than guis or curses, so we should be a little more
944
+    wary of what it does. This should be a read-only controller (ie, you can't
945
+    *do* anything to the relay) and by default not surface any sensitive
946
+    information (such as arm's connection panel).
947
+    </p>
948
+    <p>
949
+    This project will likely include two parts: an AJAX site and a localhost
950
+    daemon to fulfill those requests. <a
951
+    href="https://stem.torproject.org/">Stem</a> is the backend of arm, and can
952
+    be used to get everything you see in arm's interface (making it a natural
953
+    choice for the daemon). That said, this project might entail some Stem
954
+    improvements if we run across any gaps.
955
+    </p>
956
+    <p>
957
+    Applicants should be familiar with Python, JavaScript, and learn about
958
+    <a href="https://stem.torproject.org/">Stem</a>. <b>As part of your
959
+    application for this project please make both mockups of the interface and
960
+    a proof of concept demo application using JS to surface something with
961
+    Stem. <a
962
+    href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs">Involvement
963
+    with Stem development</a> during the application process is also a big
964
+    plus.</b>
965
+    </p>
966
+    </li>
967
+
920 968
     <a id="httpsImpersonation"></a>
921 969
     <li>
922 970
     <b>HTTPS Server Impersonation</b>