Metadata-Version: 2.1
Name: theonionbox
Version: 4.3.1
Summary: The Onion Box: WebInterface to monitor Tor node operations.
Home-page: https://github.com/ralphwetzel/theonionbox
Author: Ralph Wetzel
Author-email: theonionbox@gmx.com
License: MIT
Platform: Linux
Platform: Windows
Platform: MacOS X
Platform: FreeBSD
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Bottle
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: Utilities
Description-Content-Type: text/x-rst; charset=UTF-8


The Onion Box
=============

*The Onion Box* provides a web interface to monitor the operation of a
`Tor <https://www.torproject.org>`__ node. It is able to monitor any Tor
node operated as relay, as bridge and even as client - as long as it can
establish a connection to the node and authenticate successfully.

The connection to the Tor node to be monitored may be established via a
local ``ControlSocket`` or a ``ControlPort`` (local or remote). Advanced
users may establish a connection via the Tor network to a node proving
access to it’s ``ControlPort`` by means of a Hidden Service - supporting
on demand as well `Hidden Service Client
Authorization <https://www.torproject.org/docs/tor-manual.html.en#HiddenServiceAuthorizeClient>`__.

*The Onion Box* supports whatever authentication method the Tor node
provides.

A single instance of *The Onion Box* is able to provide monitoring
functionality for as many nodes as you like.

Above that, *The Onion Box* is able to display Tor network status
protocol data for any Tor node known by
`Onionoo <https://metrics.torproject.org/onionoo.html>`__.
