diff --git a/README.md b/README.md index e0e4a4f1..1dfa10ee 100644 --- a/README.md +++ b/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 diff --git a/docs/DOCKER.md b/docs/DOCKER.md new file mode 100644 index 00000000..a2bfa9b0 --- /dev/null +++ b/docs/DOCKER.md @@ -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 + ```