projects/en/onionoo.wml (6a9a51d40) - tor-webwml.git

onionoo.wml

## translation metadata
# Revision: $Revision: 25342 $

#include "head.wmi" TITLE="Tor Project: Onionoo" CHARSET="UTF-8"
<div id="content" class="clearfix">
	<div id="breadcrumbs">
    <a href="<page index>">Home &raquo; </a>
    <a href="<page projects/projects>">Projects &raquo; </a>
    <a href="<page projects/onionoo>">Onionoo</a>
  </div>
	<div id="maincol">

<h1>Onionoo</h1>

<p>Onionoo is a web-based protocol to learn about currently running
    Tor relays and bridges.  Onionoo itself was not designed as a service
    for human beings&mdash;at least not directly.  Onionoo provides the
    data for other applications and websites which in turn present Tor
    network status information to humans.  There are currently two
    Onionoo clients available:</p>
    <ul>
    <li><a href="https://atlas.torproject.org/">Atlas</a> is a web
    application to discover Tor relays and bridges. It provides useful
    information on how relays are configured along with graphics about
    their past.</li>
    <li><a href="https://code.google.com/p/moniono/">mOnionO</a> is an
    Android app that lets you add your relays or bridges to your favorites
    list and keeps you always informed whether they are running or
    not.</li>
    <li><a href="https://compass.torproject.org/">Compass</a>
    is a Python script and website that extracts consensus weight
    information of currently running relays and aggregates weights of
    relays running in the same country or same autonomous system.</li>
    </ul>

<h2>Developing Onionoo applications</h2>

<p>The project pages of the Onionoo clients listed above have further
    information for contacting the authors and contributing ideas or code.
    The authors will be happy to hear your thoughts!</p>

<p>You don't find your favorite Onionoo client above?  Want to
    implement your own and tell us to add it to the list?  The Onionoo
    clients above are backed by a web-based
    <a href="http://onionoo.torproject.org/">protocol</a>, which
    facilitates developing new applications displaying Tor status
    information.  Here are a few ideas for new Onionoo clients:</p>
    <ul>
    <li>Tor controller extension: Extend
    <a href="<page projects/vidalia>">Vidalia</a> and/or
    <a href="<page projects/arm>">arm</a> to look up details for the bridge
    that the user is running and display what pool the bridge is contained
    in.</li>
    <li>Social network site plugin: Add a plugin to the social network
    site of your choice to show your friends what Tor relays and bridges
    you're running and how that helps users around the world.</li>
    <li>Desktop tray icon: Write a tray icon for your favorite desktop
    environment that tells you when your relay or bridge is down and that
    displays some basic usage statistics.</li>
    <li>E-mail notification service: Improve our e-mail notification
    service <a href="https://weather.torproject.org/">Weather</a> by
    implementing its own relay search or extending it to report when a
    bridge drops off the network.</li>
    <li>Command-line tool: Implement a command-line tool that quickly
    searches a relay or bridge and prints out some status information to
    help debug problems.</li>
    <li>(Insert your idea here.)</li>
    </ul>

<p>Want to help with developing the Onionoo server that provides
    Tor status data, or want to run your own Onionoo server instance?  The
    Onionoo server is written in Java with a tiny portion of Java
    Servlets.  Instructions for setting up the Onionoo server to fetch the
    required data from the Tor servers is described in the INSTALL file in
    the sources.  For more details see the
    <a href="https://gitweb.torproject.org/onionoo.git">source code</a> and
    <a href="https://trac.torproject.org/projects/tor/query?status=!closed&component=Onionoo">issue
    tracker</a>.</p>

<h2>Related projects</h2>

<p>TorStatus is the name of a nowadays
    <a href="https://svn.torproject.org/svn/torstatus/trunk/">unmaintained</a>
    website that displays Tor relay information similar to
    <a href="http://atlas.torproject.org/">Atlas</a>.  There are still a
    few <a href="http://torstatus.all.de/">TorStatus websites</a>
    running.</p>

<p>There's another project from summer 2011 called TorStatus which is
    a <a href="https://gitweb.torproject.org/torstatus.git">rewrite</a> of
    the original TorStatus in Python/Django.  Unfortunately, it's also
    unmaintained.</p>

<p>Finally, there's the
    <a href="https://metrics.torproject.org/consensus-health.html">consensus-health
    page</a> which has the primary purpose of indicating problems with
    creating a network status consensus.  As a side-effect this page lists
    all currently running relays and how the directory authorities voted
    on them.</p>

</div>
  
  <div id = "sidecol">
#include "side.wmi"
#include "info.wmi"
  </div>
  
</div>

#include <foot.wmi>

tor-webwml.git

Fix link to Compass (#6624).