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
squeaknode/README.md
Jonathan Zernik 64643b25a8
Use docker compose overrides for testnet mainnet (#482) 
* Use default override file for docker-compose testnet

* Add mainnet docker-compose override file

* Put common environment variables in main docker-compose file

* Update readme with instructions for mainnet override
2020-11-23 20:43:19 -05:00

1.5 KiB
Raw Blame History

squeaknode

Node for Squeak protocol

Run with docker:

Requirements
  • docker
  • docker-compose
  • Enough disk space for the bitcoin blockchain
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:

Requirements
  • A running bitcoin node
  • A running lnd node
  • Python3.6
Steps

  • Create a config.ini file and fill in the relevant sections to connect to your bitcoin and lnd nodes:

    [squeaknode]
network=testnet
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
rpc_port=10009
tls_cert_path=~/.lnd/tls.cert
macaroon_path=~/.lnd/data/chain/bitcoin/testnet/admin.macaroon

[webadmin]
enabled=true
username=devuser
password=devpass

  • Install squeaknode:

    $ pip install squeaknode

    or

    $ python setup.py install

  • Start the squeak server:

    $ runsqueaknode --config config.ini run-server

  • Go to http://localhost:12994/ and use the username/password in config.ini to log in.

Test

Run unit tests:

$ make test

Run integration tests:

$ make itest