Code Monkey home page Code Monkey logo

theonionbox-docker's Introduction

theonionbox-docker

This docker provides a simple way to run The Onion Box

The Onion Box provides a web interface to monitor the operation of a Tor 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 must have either a ControlSocket or a ControlPort enabled. 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.

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.

Quickstart - The Onion Box in minutes

Prerequisites:

  • A Tor Relay with it's ControlPort enabled on 0.0.0.0:9051 (listening for connections outside of localhost is not usually recommended but if you aren't forwarding the port on your router you should be fine)
  • Docker installed.

Create a directory for your config file and download a copy of the default config file:

mkdir -vp theonionbox && \
wget https://raw.githubusercontent.com/josh-gaby/theonionbox/master/Docker/theonionbox.cfg -O theonionbox/tob.cfg

Edit the config file and update the [Tor] section to point to your main tor relay, you will be able setup more relay nodes from the web interface once its running.

control = port
host = 192.168.1.7   # your tor relays ip
port = 9051          # your tor relays ControlPort as set in its torrc

Run the docker

docker run -d --init --name=theonionbox --net=host \
-e cc_enabled=true \
-v $PWD/theonionbox/tob.cfg:/theonionbox-config/theonionbox.cfg \
--restart=always joshgaby/theonionbox

theonionbox-docker's People

Contributors

josh-gaby avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.