Document proxyconfig_stem

This commit is contained in:
Dmitri Bogomolov 2019-10-22 10:10:41 +03:00
parent 2bddae511a
commit 52d5c1ff03
Signed by untrusted user: g1itch
GPG Key ID: 720A756F18DEED13

View File

@ -1,7 +1,15 @@
# -*- coding: utf-8 -*-
Configure tor proxy and hidden service with
`stem <>`_ depending on *bitmessagesettings*:
* try to start own tor instance on *socksport* if *sockshostname*
is unset or set to localhost;
* if *socksport* is already in use that instance is used only for
hidden service (if *sockslisten* is also set True);
* create ephemeral hidden service v3 if there is already *onionhostname*;
* otherwise use stem's 'BEST' version and save onion keys to the new
section using *onionhostname* as name for future use.
import os
import logging
@ -36,10 +44,16 @@ class DebugLogger(object):
def connect_plugin(config): # pylint: disable=too-many-branches
"""Run stem proxy configurator"""
Run stem proxy configurator
:param config: current configuration instance
:type config: :class:`pybitmessage.bmconfigparser.BMConfigParser`
:return: True if configuration was done successfully
logwrite = DebugLogger()
if config.safeGet('bitmessagesettings', 'sockshostname') not in (
'localhost', '', ''
if config.safeGet('bitmessagesettings', 'sockshostname', '') not in (
'localhost', '', ''
# remote proxy is choosen for outbound connections,
# nothing to do here, but need to set socksproxytype to SOCKS5!