git-annex/doc/git-annex-enable-tor.mdwn
Joey Hess b184fc490a
split out common options to its own page and mention it on each subcommand page
Sometimes users would get confused because an option they were looking
for was not mentioned on a subcommand's man page, and they had not
noticed that the main git-annex man page had a list of common options.
This change lets each subcommand mention the common options, similarly
to how the matching options are handled.

This commit was sponsored by Svenne Krap on Patreon.
2021-05-10 15:00:13 -04:00

40 lines
928 B
Markdown

# NAME
git-annex enable-tor - enable tor hidden service
# SYNOPSIS
git annex enable-tor
sudo git annex enable-tor $(id -u)
# DESCRIPTION
This command enables a tor hidden service for git-annex.
It modifies `/etc/tor/torrc` to register the hidden service. If run as a
normal user, it will try to use sudo/su/etc to get root access to modify
that file. If you run it as root, pass it your non-root user id number,
as output by `id -u`
After this command is run, `git annex remotedaemon` can be run to serve the
tor hidden service, and then `git-annex p2p --gen-address` can be run to
give other users access to your repository via the tor hidden service.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
[[git-annex-p2p-auth]](1)
[[git-annex-remotedaemon]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.