mirror of
https://github.com/bitcoin-s/bitcoin-s.git
synced 2025-03-15 12:20:06 +01:00
194 lines
No EOL
32 KiB
HTML
194 lines
No EOL
32 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Tor Setup · bitcoin-s</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="It is possible to run Bitcoin-S through tor."/><meta name="docsearch:version" content="1.8.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Tor Setup · bitcoin-s"/><meta property="og:type" content="website"/><meta property="og:url" content="https://bitcoin-s.org/"/><meta property="og:description" content="It is possible to run Bitcoin-S through tor."/><meta property="og:image" content="https://bitcoin-s.org/img/undraw_online.svg"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://bitcoin-s.org/img/undraw_tweetstorm.svg"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-61958686-2', 'auto');
|
||
ga('send', 'pageview');
|
||
</script><link rel="stylesheet" href="/css/code-block-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="https://fonts.googleapis.com/css?family=Montserrat:500"></script><script type="text/javascript" src="https://www.googletagmanager.com/gtag/js?id=UA-61958686-2"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/favicon.ico" alt="bitcoin-s"/><h2 class="headerTitleWithLogo">bitcoin-s</h2></a><a href="/versions"><h3>1.8.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/1.8.0/core/core-intro" target="_self">Docs</a></li><li class=""><a href="/download" target="_self">Download</a></li><li class=""><a href="/api/org/bitcoins" target="_self">API</a></li><li class=""><a href="/help" target="_self">Help</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Tor</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/getting-started">Intro and Getting Started</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/bips">Supported BIPs</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Setup</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/getting-setup">Getting Bitcoin-S installed on your machine</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Applications</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/applications/cli">CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/applications/server">Application Server</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/applications/gui">GUI</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/applications/server-systemd">Systemd installation</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Chain</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/chain/chain">Blockchain Verification</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/chain/filter-sync">Syncing Blockfilters</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/chain/chain-query-api">Chain Query API</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Configuration</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/config/configuration">Application Configuration</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Core Module</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/core-intro">Core Module</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/addresses">Generating Addresses</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/hd-keys">HD Key Generation</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/adding-spks">Adding New Script Types</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/spending-info">Signing Transactions</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/psbts">Partially Signed Bitcoin Transactions</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/dlc">Discreet Log Contract Data Structures</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/txbuilder">TxBuilder Example</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/core/lightning-network">Lightning Network Data Types</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Crypto Module</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/crypto/crypto-intro">Crypto Module</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/crypto/sign">Sign API</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/crypto/adaptor-signatures">Adaptor Signatures</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Fee Provider</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/fee-provider/fee-provider">Fee Provider</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Key Manager</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/key-manager/server-key-manager">Server Key Manager</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/key-manager/key-manager">Key Manager</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Node</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/node/node">Light Client</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/node/node-api">Node API</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Wallet</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/wallet">Wallet</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/wallet-callbacks">Wallet Callbacks</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/wallet-get-address">Wallet Get Address APIs</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/address-tagging">Address and UTXO tagging</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/dlc">Executing A DLC with Bitcoin-S</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/wallet-rescan">Wallet Rescans</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/wallet-sync">Wallet Sync</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/wallet-rpc">Wallet RPC Examples</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/backups">Wallet Backups</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/wallet-election-example">Wallet Election Example</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/wallet/wallet-price-example">Wallet Price Example</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Tor</h3><ul class=""><li class="navListItem navListItemActive"><a class="navItem" href="/docs/1.8.0/tor/tor">Tor Setup</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">RPC Clients</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/rpc/rpc-clients-intro">Introduction</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/rpc/rpc-eclair">Eclair</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/rpc/rpc-bitcoind">bitcoind/Bitcoin Core</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/rpc/lnd-rpc">LND</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Secp256k1</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/secp256k1/secp256k1">Secp256k1</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/secp256k1/jni-modify">Adding to Secp256k1 JNI</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Testkit</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/testkit/testkit">Testkit</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/testkit/testkit-core">Testkit Core</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">DLC Oracle</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/oracle/build-oracle-server">Building the Oracle Server</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/oracle/oracle-server">Oracle Server</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/oracle/oracle-election-example">Election Example</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/oracle/oracle-price-example">Price Example</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Oracle Explorer Client</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/oracle-explorer-client/oracle-explorer-client">Oracle Explorer Client</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Contributing</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/contributing">Contributing</a></li><li class="navListItem"><a class="navItem" href="/docs/1.8.0/contributing-website">Contributing to the website</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Security</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/1.8.0/security">Security</a></li></ul></div></div></section></div><script>
|
||
var coll = document.getElementsByClassName('collapsible');
|
||
var checkActiveCategory = true;
|
||
for (var i = 0; i < coll.length; i++) {
|
||
var links = coll[i].nextElementSibling.getElementsByTagName('*');
|
||
if (checkActiveCategory){
|
||
for (var j = 0; j < links.length; j++) {
|
||
if (links[j].classList.contains('navListItemActive')){
|
||
coll[i].nextElementSibling.classList.toggle('hide');
|
||
coll[i].childNodes[1].classList.toggle('rotate');
|
||
checkActiveCategory = false;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
|
||
coll[i].addEventListener('click', function() {
|
||
var arrow = this.childNodes[1];
|
||
arrow.classList.toggle('rotate');
|
||
var content = this.nextElementSibling;
|
||
content.classList.toggle('hide');
|
||
});
|
||
}
|
||
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||
createToggler('#tocToggler', 'body', 'tocActive');
|
||
|
||
var headings = document.querySelector('.toc-headings');
|
||
headings && headings.addEventListener('click', function(event) {
|
||
var el = event.target;
|
||
while(el !== headings){
|
||
if (el.tagName === 'A') {
|
||
document.body.classList.remove('tocActive');
|
||
break;
|
||
} else{
|
||
el = el.parentNode;
|
||
}
|
||
}
|
||
}, false);
|
||
|
||
function createToggler(togglerSelector, targetSelector, className) {
|
||
var toggler = document.querySelector(togglerSelector);
|
||
var target = document.querySelector(targetSelector);
|
||
|
||
if (!toggler) {
|
||
return;
|
||
}
|
||
|
||
toggler.onclick = function(event) {
|
||
event.preventDefault();
|
||
|
||
target.classList.toggle(className);
|
||
};
|
||
}
|
||
});
|
||
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/bitcoin-s/bitcoin-s/blob/master/docs/tor/tor.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Tor Setup</h1></header><article><div><span><p>It is possible to run Bitcoin-S through tor.
|
||
<a href="https://www.torproject.org/">Tor</a> is an onion routed private network that allows us to send and receive messages in an
|
||
anonymous manner. Using tor in conjunction with Bitcoin-S allows you to be more private when syncing the blockchain, as
|
||
well as allows for sending and receiving DLC messages without the need for a static IP address or opening/forwarding of
|
||
ports.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="installing-tor"></a><a href="#installing-tor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Installing Tor</h2>
|
||
<h3><a class="anchor" aria-hidden="true" id="debian"></a><a href="#debian" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Debian</h3>
|
||
<p>You can install tor using <code>sudo apt install tor</code> if on a debian system.</p>
|
||
<p>After installing you can start it with <code>sudo systemctl start tor</code></p>
|
||
<h3><a class="anchor" aria-hidden="true" id="brew"></a><a href="#brew" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Brew</h3>
|
||
<p>You can install tor using <code>brew install tor</code> if on a mac osx system.</p>
|
||
<p>After installing you can start it with <code>brew services start tor</code></p>
|
||
<h3><a class="anchor" aria-hidden="true" id="other"></a><a href="#other" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Other</h3>
|
||
<p>Otherwise, you can install the Tor Browser from <a href="https://www.torproject.org/download/">here</a>.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="starting-tor"></a><a href="#starting-tor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Starting Tor</h2>
|
||
<p>To connect to onion addresses you need to enable the tor proxy. To do so you need to have tor currently running, this
|
||
can be checked by using the command <code>sudo systemctl status tor</code>. This should give you an output similar to:</p>
|
||
<pre><code class="hljs css language-bash">$ sudo systemctl status tor
|
||
● tor.service - Anonymizing overlay network <span class="hljs-keyword">for</span> TCP (multi-instance-master)
|
||
Loaded: loaded (/lib/systemd/system/tor.service; enabled; vendor preset: enabled)
|
||
Active: active (exited) since Wed 2021-07-28 13:06:42 CDT; 48min ago
|
||
Main PID: 804 (code=exited, status=0/SUCCESS)
|
||
Tasks: 0 (<span class="hljs-built_in">limit</span>: 18696)
|
||
Memory: 0B
|
||
CGroup: /system.slice/tor.service
|
||
</code></pre>
|
||
<p>If the output says <code>Active: active</code>, then it is running and good to go.</p>
|
||
<p>On mac osx you can use the command <code>brew services list</code> to ensure tor is running. This should give you an output similar to:</p>
|
||
<pre><code class="hljs css language-bash">$ brew services list
|
||
Name Status User Plist
|
||
tor started <span class="hljs-variable">$username</span> /Users/username/Library/LaunchAgents/homebrew.mxcl.tor.plist
|
||
</code></pre>
|
||
<p>If tor satus is <code>started</code>, then it is running and good to go.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="enabling-the-tor-proxy"></a><a href="#enabling-the-tor-proxy" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Enabling the Tor proxy</h2>
|
||
<p>Enabling the tor proxy allows you to create outgoing connections over tor. This is needed if you want to sync the
|
||
blockchain over tor, or to accept DLCs over tor.</p>
|
||
<p>To enable the tor proxy you simply need to set a couple config options after you have tor running.</p>
|
||
<p>You need to enable the proxy and set the host and port configuration options. If you are using the default settings you
|
||
should only need to set <code>bitcoin-s.proxy.enabled = true</code>.
|
||
These modifications need to be made to <code>$HOME/.bitcoin-s/bitcoin-s.conf</code> file.
|
||
Create this file if it does not exist.</p>
|
||
<pre><code class="hljs css language-$xslt">bitcoin-s {
|
||
<span class="hljs-built_in"> proxy </span>{
|
||
# You can configure SOCKS5<span class="hljs-built_in"> proxy </span><span class="hljs-keyword">to</span> use Tor <span class="hljs-keyword">for</span> outgoing connections
|
||
enabled = <span class="hljs-literal">true</span>
|
||
sock5 = <span class="hljs-string">"127.0.0.1:9050"</span>
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h2><a class="anchor" aria-hidden="true" id="creating-our-own-tor-hidden-service"></a><a href="#creating-our-own-tor-hidden-service" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Creating our own Tor hidden service</h2>
|
||
<p>Enabling the tor hidden services allows for inbound connections over tor.
|
||
This is needed if you want to create DLCs over tor.</p>
|
||
<p>To enable the tor hidden services you need to set a couple config options after you have tor running in your bitcoin-s
|
||
config, as well as have tor configured for it.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="configuring-tor"></a><a href="#configuring-tor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Configuring Tor</h3>
|
||
<p>You may need to set up the Tor Control Port. On Linux distributions there may be some or all of the following settings
|
||
in <code>/etc/tor/torrc</code> for linux or <code>/opt/homebrew/etc/tor/torrc</code> for mac, generally commented out by default (if not, add
|
||
them):</p>
|
||
<pre><code class="hljs">ControlPort <span class="hljs-number">9051</span>
|
||
CookieAuthentication <span class="hljs-number">1</span>
|
||
CookieAuthFileGroupReadable <span class="hljs-number">1</span>
|
||
</code></pre>
|
||
<p>Add or uncomment those, save, and restart Tor (usually <code>systemctl restart tor</code>
|
||
or <code>sudo systemctl restart tor</code> on most systemd-based systems, including recent Debian and Ubuntu, <code>brew services restart tor</code> on mac osx, or just restart the
|
||
computer).</p>
|
||
<p>On some systems (such as Arch Linux), you may also need to add the following line:</p>
|
||
<pre><code class="hljs">DataDirectoryGroupReadable <span class="hljs-number">1</span>
|
||
</code></pre>
|
||
<p>You may also need permissions for the auth cookie file, this can be done doing</p>
|
||
<pre><code class="hljs css language-bash">sudo usermod -a -G debian-tor <span class="hljs-variable">$USER</span>
|
||
</code></pre>
|
||
<p>or on mac</p>
|
||
<pre><code class="hljs">sudo chmod <span class="hljs-number">755</span> <span class="hljs-regexp">/usr/</span>local<span class="hljs-regexp">/var/</span>tor
|
||
</code></pre>
|
||
<p>After changing these settings, you will need to restart your computer.</p>
|
||
<h3><a class="anchor" aria-hidden="true" id="optional-settings"></a><a href="#optional-settings" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Optional Settings</h3>
|
||
<p>If you experience repeated connection issues make sure to check the bitcoin-s.log file. If the logs show that Bitcoin-s is able to connect through the tor proxy (<code>connected to neutrino.suredbits.com/:8333 via SOCKS5 proxy /127.0.0.1:9050</code>) but is not able to connect through the tor controller (<code>TorController refused to connect</code> or similar) you may need to make additional changes to your torrc file. Find the location of your tor control_auth_cookie file and add the pathname for this file to your torrc file as show below.
|
||
For mac osx:</p>
|
||
<pre><code class="hljs">CookieAuthFile /usr/<span class="hljs-keyword">local</span>/<span class="hljs-keyword">var</span>/tor/control_auth_cookie
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="configuring-bitcoin-s"></a><a href="#configuring-bitcoin-s" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Configuring Bitcoin-S</h3>
|
||
<p>You need to enable tor and set the control option, <code>127.0.0.1:9051</code> is the default. If you are using the default
|
||
settings you should only need to set <code>bitcoin-s.tor.enabled = true</code>.
|
||
These modifications need to be made to <code>$HOME/.bitcoin-s/bitcoin-s.conf</code> file.
|
||
Create this file if it does not exist.</p>
|
||
<pre><code class="hljs css language-$xslt">bitcoin-s {
|
||
tor {
|
||
# You can <span class="hljs-builtin-name">enable</span> Tor <span class="hljs-keyword">for</span><span class="hljs-built_in"> incoming </span>connections
|
||
enabled = <span class="hljs-literal">true</span>
|
||
control = <span class="hljs-string">"127.0.0.1:9051"</span>
|
||
|
||
# The password used <span class="hljs-keyword">to</span> arrive at the HashedControlPassword <span class="hljs-keyword">for</span> the control port.
|
||
# <span class="hljs-keyword">If</span> provided, the HASHEDPASSWORD authentication method will be used instead of
|
||
# the SAFECOOKIE one.
|
||
# password = securePassword
|
||
|
||
# The path <span class="hljs-keyword">to</span> the private key of the onion<span class="hljs-built_in"> service </span>being created
|
||
# privateKeyPath = /path/<span class="hljs-keyword">to</span>/priv/key
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h3><a class="anchor" aria-hidden="true" id="manually-creating-a-tor-hidden-service"></a><a href="#manually-creating-a-tor-hidden-service" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Manually Creating a Tor Hidden Service</h3>
|
||
<p>Alternatively, you can manually create a tor hidden service.</p>
|
||
<p>You can also manually configure your node to be reachable from the Tor network. Add these lines to
|
||
your <code>/etc/tor/torrc</code> (or equivalent config file, mac is located at <code>/opt/homebrew/etc/tor/torrc</code>):</p>
|
||
<pre><code class="hljs">HiddenServiceDir /var/<span class="hljs-class"><span class="hljs-keyword">lib</span>/<span class="hljs-title">tor</span>/<span class="hljs-title">dlc</span>-<span class="hljs-title">service</span>/</span>
|
||
HiddenServicePort <span class="hljs-number">2862</span> <span class="hljs-number">127.0</span>.<span class="hljs-number">0.1</span>:<span class="hljs-number">2862</span>
|
||
</code></pre>
|
||
<p>Then to get your host address simply do this after restarting your tor daemon.</p>
|
||
<pre><code class="hljs css language-bash">sudo cat /var/lib/tor/dlc-service/hostname
|
||
</code></pre>
|
||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 8/16/2021 by Sam Bradbury</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/1.8.0/wallet/wallet-price-example"><span class="arrow-prev">← </span><span>Wallet Price Example</span></a><a class="docs-next button" href="/docs/1.8.0/rpc/rpc-clients-intro"><span>Introduction</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-tor">Installing Tor</a><ul class="toc-headings"><li><a href="#debian">Debian</a></li><li><a href="#brew">Brew</a></li><li><a href="#other">Other</a></li></ul></li><li><a href="#starting-tor">Starting Tor</a></li><li><a href="#enabling-the-tor-proxy">Enabling the Tor proxy</a></li><li><a href="#creating-our-own-tor-hidden-service">Creating our own Tor hidden service</a><ul class="toc-headings"><li><a href="#configuring-tor">Configuring Tor</a></li><li><a href="#optional-settings">Optional Settings</a></li><li><a href="#configuring-bitcoin-s">Configuring Bitcoin-S</a></li><li><a href="#manually-creating-a-tor-hidden-service">Manually Creating a Tor Hidden Service</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/favicon.ico" alt="bitcoin-s" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/getting-started">Getting Started</a><a href="/docs/en/core/core-intro">Guides</a><a href="/api/org/bitcoins">API Reference</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw" target="_blank" rel="noreferrer noopener">Slack</a><a href="https://gitter.im/bitcoin-s-core/">Gitter chat</a></div><div><h5>More</h5><a href="https://github.com/bitcoin-s/bitcoin-s">GitHub</a><a class="github-button" href="https://github.com/bitcoin-s/bitcoin-s" data-icon="octicon-star" data-count-href="/bitcoin-s/bitcoin-s-core/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2025 Suredbits & the bitcoin-s developers</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
|
||
document.addEventListener('keyup', function(e) {
|
||
if (e.target !== document.body) {
|
||
return;
|
||
}
|
||
// keyCode for '/' (slash)
|
||
if (e.keyCode === 191) {
|
||
const search = document.getElementById('search_input_react');
|
||
search && search.focus();
|
||
}
|
||
});
|
||
</script><script>
|
||
var search = docsearch({
|
||
|
||
apiKey: '0a510688bf8448e19aeb380377d328d3',
|
||
indexName: 'bitcoin-s',
|
||
inputSelector: '#search_input_react'
|
||
});
|
||
</script></body></html> |