mirror of
https://github.com/yzernik/squeaknode.git
synced 2026-08-18 13:09:08 +02:00
Update readme for launching no docker (#520)
* Update readme and add separate doc for launching docker * Fix typo
This commit is contained in:
parent
e966f73db1
commit
b39f308a90
2 changed files with 31 additions and 22 deletions
34
README.md
34
README.md
|
|
@ -2,26 +2,16 @@
|
|||
|
||||
Node for Squeak protocol
|
||||
|
||||
### Run with docker:
|
||||
### Run a node:
|
||||
|
||||
##### Requirements
|
||||
* docker
|
||||
* docker-compose
|
||||
* Enough disk space for the bitcoin blockchain
|
||||
* a bitcoin node
|
||||
* an LND node
|
||||
* Python 3.7 or later
|
||||
|
||||
If you don't already have a bitcoin node or lightning node, you can [follow the instructions](docs/DOCKER.md) follow the instructions here to launch them in Docker.
|
||||
|
||||
##### Steps
|
||||
- Build and start docker-compose:
|
||||
```
|
||||
$ cd docker
|
||||
$ docker-compose build
|
||||
$ docker-compose up
|
||||
```
|
||||
- If you want to use mainnet, run with the `docker-compose.mainnet.yml` override file:
|
||||
```
|
||||
$ docker-compose -f docker-compose.yml -f docker-compose.mainnet.yml up
|
||||
```
|
||||
- Go to http://localhost:12994/ and use the username/password in **docker/config.ini** to log in.
|
||||
|
||||
|
||||
### Run without docker:
|
||||
|
||||
|
|
@ -38,12 +28,6 @@ Node for Squeak protocol
|
|||
price_msat=1000000
|
||||
sync_interval_s=10
|
||||
|
||||
[bitcoin]
|
||||
rpc_host=localhost
|
||||
rpc_port=18334
|
||||
rpc_user=devuser
|
||||
rpc_pass=devpass
|
||||
|
||||
[lnd]
|
||||
host=localhost
|
||||
port=9735
|
||||
|
|
@ -51,6 +35,12 @@ Node for Squeak protocol
|
|||
tls_cert_path=~/.lnd/tls.cert
|
||||
macaroon_path=~/.lnd/data/chain/bitcoin/testnet/admin.macaroon
|
||||
|
||||
[bitcoin]
|
||||
rpc_host=localhost
|
||||
rpc_port=18334
|
||||
rpc_user=devuser
|
||||
rpc_pass=devpass
|
||||
|
||||
[webadmin]
|
||||
enabled=true
|
||||
username=devuser
|
||||
|
|
|
|||
19
docs/DOCKER.md
Normal file
19
docs/DOCKER.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# Running bitcoin-core and LND with Docker
|
||||
|
||||
If you don't already have your own bitcoin node and lightning node, you can use docker-compose to launch new ones.
|
||||
|
||||
##### Steps
|
||||
- Build and start docker-compose:
|
||||
```
|
||||
$ cd docker
|
||||
$ docker-compose build
|
||||
$ docker-compose up
|
||||
```
|
||||
- If you want to use testnet, run the normal `up` command:
|
||||
```
|
||||
$ docker-compose up
|
||||
```
|
||||
- If you want to use mainnet, run with the `docker-compose.mainnet.yml` override file:
|
||||
```
|
||||
$ docker-compose -f docker-compose.yml -f docker-compose.mainnet.yml up
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue