Complete client implementation of the Tor Control Protocol. Control a running Tor instance from Node.js!
Install via NPM:
npm install granax --save
As part of the installation process, Granax will download the Tor Browser
Bundle local to itself and use the included Tor executable, however on
GNU+Linux, you may opt for Granax to use the system Tor installed using your
distribution's package manager by setting
You can also tell Granax to install the latest alpha release of Tor instead of
the latest stable release, with
const tor = ;tor;tor;
Using System Tor Package
Make sure that
ControlPort=9051 (or your preferred port) is set in your
torrc, then you may open the control socket and issue commands:
const connect = ;const TorController = ;const tor = options;tor;
Note that if using cookie authentication, the Node.js process must have the appropriate privileges to read the cookie file. Usually, this means running as the same user that is running Tor.
Granax - Complete client implementation of the Tor Control Protocol
Copyright (C) 2017 Gordon Hall
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.