mirror of
https://github.com/talaia-labs/rust-teos.git
synced 2026-08-13 12:33:22 +02:00
Updates readmes
This commit is contained in:
parent
b035a3e460
commit
197ae93534
2 changed files with 5 additions and 4 deletions
|
|
@ -66,13 +66,13 @@ For regtest, it should look like:
|
|||
btc_network = regtest
|
||||
```
|
||||
|
||||
### Running `teosd` with tor
|
||||
### Running `teosd` with Tor
|
||||
|
||||
This requires a Tor daemon running on the same machine as `teosd` and a control port open on that daemon.
|
||||
|
||||
Download Tor from the [torproject site](https://www.torproject.org/download/).
|
||||
|
||||
To open tor's control port, you add the following to the Tor config file ([source](https://2019.www.torproject.org/docs/faq.html.en#torrc)):
|
||||
To open Tor's control port, you add the following to the Tor config file ([source](https://2019.www.torproject.org/docs/faq.html.en#torrc)):
|
||||
|
||||
```
|
||||
## The port on which Tor will listen for local connections from Tor
|
||||
|
|
|
|||
|
|
@ -109,9 +109,10 @@ Config options can be setup directly in the [CLN config file](https://github.com
|
|||
|
||||
- `watchtower-port`: default tower API port.
|
||||
- `watchtower-max-retry-time`: the maximum time a retry strategy will try to reach a temporary unreachable tower before giving up.
|
||||
- `watchtower-proxy`: informs the plugin that you have a SOCKS5 proxy at the given `ip:port`. Notice this is necessary if you want to connect to a tower through Tor!
|
||||
- `proxy`: Set a socks v5 proxy IP address and port. Notice this is necessary if you want to connect to a tower through Tor!
|
||||
- `always-use-proxy`: Use the proxy always (default: false).
|
||||
|
||||
**DISCLAIMER**: This option will be eventually replaced by the CoreLN `proxy` / `always-use-proxy` options. In the current state of the `cln-plugin` crate there is no option to access the CoreLN main configuration, therefore the need for a temporary, plugin-specific, option.
|
||||
Notice `proxy` and `always-use-proxy` are general CLN options that are honored by the plugin, so if set the plugin will use Tor to communicate with the tower.
|
||||
|
||||
# Getting started
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue