git-annex/doc/git-annex-enable-tor.mdwn
Joey Hess 07ad19f421
git-annex enable-tor command
Tor unfortunately does not come out of the box configured to let hidden
services register themselves on the fly via the ControlPort.

And, changing the config to enable the ControlPort and a particular type
of auth for it may break something already using the ControlPort, or
lessen the security of the system.

So, this leaves only one option to us: Add a hidden service to the
torrc. git-annex enable-tor does so, and picks an unused high port for
tor to listen on for connections to the hidden service.

It's up to the caller to somehow pick a local port to listen on
that won't be used by something else. That may be difficult to do..

This commit was sponsored by Jochen Bartl on Patreon.
2016-11-14 13:48:35 -04:00

25 lines
513 B
Markdown

# NAME
git-annex enable-tor - enable tor hidden service
# SYNOPSIS
git annex enable-tor localport
# DESCRIPTION
This plumbing-level command enables a tor hidden service for git-annex,
using the specified local port number. It outputs to stdout a line
of the form "address.onion:onionport"
This command has to be run by root, since it modifies `/etc/tor/torrc`.
# SEE ALSO
[[git-annex]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.