GlcoinCore/squeaknode
1
0
Fork 0
mirror of https://github.com/yzernik/squeaknode.git synced 2026-08-13 12:33:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme headers (#1761)

Browse source 
* Change readme headers

* Add spaces around code blocks in readme

* Change wording about configs

* Fix indentation in readme
This commit is contained in:
Jonathan Zernik 2021-11-04 23:28:27 -07:00 • committed by GitHub
parent f9621ad3ed
commit 5e8174fa28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

81
README.md
View file

@ -5,9 +5,9 @@
Node for [Squeak protocol](https://github.com/yzernik/squeak/blob/master/docs/PROTOCOL.md)
### Run a node:
## Installation
#### Requirements
### Requirements
* a Bitcoin node
* an LND node
* Python 3.6 or later
@ -15,48 +15,53 @@ Node for [Squeak protocol](https://github.com/yzernik/squeak/blob/master/docs/PR
#### Optional
* a Tor SOCKS5 proxy (you can open Tor Browser and run it in the background)
#### Steps
- Update the **config.ini** file and fill in the relevant sections to connect to your Bitcoin node and LND node:
```
[node]
network=mainnet
### Step 1. Create the configuration
> Update the **config.ini** file and fill in the relevant sections to connect to your Bitcoin node and LND node:
[lnd]
host=localhost
tls_cert_path=~/.lnd/tls.cert
macaroon_path=~/.lnd/data/chain/bitcoin/mainnet/admin.macaroon
```
[node]
network=mainnet
[bitcoin]
rpc_host=localhost
rpc_port=8332
rpc_user=devuser
rpc_pass=devpass
zeromq_hashblock_port=28334
[lnd]
host=localhost
tls_cert_path=~/.lnd/tls.cert
macaroon_path=~/.lnd/data/chain/bitcoin/mainnet/admin.macaroon
[tor]
proxy_ip=localhost
proxy_port=9150
[bitcoin]
rpc_host=localhost
rpc_port=8332
rpc_user=devuser
rpc_pass=devpass
zeromq_hashblock_port=28334
[webadmin]
enabled=true
username=devuser
password=devpass
```
[tor]
proxy_ip=localhost
proxy_port=9150
More information about [configs](docs/CONFIGURATION.md).
[webadmin]
enabled=true
username=devuser
password=devpass
```
- Install squeaknode:
```
$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ pip install .
```
- Start squeaknode:
```
$ squeaknode --config config.ini
```
- Go to http://localhost:12994/ and use the username/password in **config.ini** to log in.
Add any other [configs](docs/CONFIGURATION.md) that you need.
### Step 2. Install squeaknode:
```
$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ pip install .
```
### Step 3. Start squeaknode:
```
$ squeaknode --config config.ini
```
Go to http://localhost:12994/ and use the username/password in **config.ini** to log in.
## Test