aljaz/python-teos
1
0
Fork 0
mirror of https://github.com/aljazceru/python-teos.git synced 2025-12-17 06:04:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs - updates readme with feed data

Browse Source
This commit is contained in:
Sergi Delgado Segura
2020-06-09 09:25:07 +02:00
parent 10da7d2a10
commit 6698a1a892
2 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -105,6 +105,8 @@ Notice that ENV variables are optional, if unset the corresponding default setti
- BTC_RPC_PORT=<btc node port> - BTC_RPC_PORT=<btc node port>
- BTC_RPC_USER=<rpc username> - BTC_RPC_USER=<rpc username>
- BTC_RPC_PASSWORD=<rpc password> - BTC_RPC_PASSWORD=<rpc password>
- BTC_FEED_CONNECT=<btc zmq hostname>
- BTC_FEED_PORT=<btc zmq port>
``` ```
If you are running `teos` and `bitcoind` in the same machine, continue reading for how to create the container based on your OS. If you are running `teos` and `bitcoind` in the same machine, continue reading for how to create the container based on your OS.
@@ -122,7 +124,7 @@ Notice that you may still need to set your RPC authentication details, since, ho
Docker for OSX and Windows do not allow to use the host network (nor to use the `docker0` bridge interface). To workaround this Docker for OSX and Windows do not allow to use the host network (nor to use the `docker0` bridge interface). To workaround this
you can use the special `host.docker.internal` domain. you can use the special `host.docker.internal` domain.
docker run -it -e BTC_RPC_CONNECT=host.docker.internal -e BTC_RPC_USER=<rpc username> -e BTC_RPC_PASSWD=<rpc password> teos docker run -p 9814 -it -e BTC_RPC_CONNECT=host.docker.internal -e BTC_FEED_CONNECT=host.docker.internal -e BTC_RPC_USER=<rpc username> -e BTC_RPC_PASSWD=<rpc password> teos
## Interacting with a TEOS Instance ## Interacting with a TEOS Instance

20
teos/help.py
View File

@@ -2,15 +2,17 @@ def show_usage():
return ( return (
"USAGE: " "USAGE: "
"\n\tpython teosd.py [global options]" "\n\tpython teosd.py [global options]"
"\n\nGLOBAL OPTIONS:" "\n\nGLOBAL OPTIONS (all modifiable in conf file):"
"\n\t--apibind \t\taddress that teos API will bind to. Defaults to 'localhost' (modifiable in conf file)." "\n\t--apibind \t\taddress that teos API will bind to. Defaults to 'localhost'."
"\n\t--apiport \t\tport that teos API will bind to. Defaults to '9814' (modifiable in conf file)." "\n\t--apiport \t\tport that teos API will bind to. Defaults to '9814'."
"\n\t--btcnetwork \t\tNetwork bitcoind is connected to. Either mainnet, testnet or regtest. Defaults to " "\n\t--btcnetwork \t\tNetwork bitcoind is connected to. Either mainnet, testnet or regtest. Defaults to "
"'mainnet' (modifiable in conf file)." "'mainnet'."
"\n\t--btcrpcuser \t\tbitcoind rpcuser. Defaults to 'user' (modifiable in conf file)." "\n\t--btcrpcuser \t\tbitcoind rpcuser. Defaults to 'user'."
"\n\t--btcrpcpassword \tbitcoind rpcpassword. Defaults to 'passwd' (modifiable in conf file)." "\n\t--btcrpcpassword \tbitcoind rpcpassword. Defaults to 'passwd'."
"\n\t--btcrpcconnect \tbitcoind rpcconnect. Defaults to 'localhost' (modifiable in conf file)." "\n\t--btcrpcconnect \tbitcoind rpcconnect. Defaults to 'localhost'."
"\n\t--btcrpcport \t\tbitcoind rpcport. Defaults to '8332' (modifiable in conf file)." "\n\t--btcrpcport \t\tbitcoind rpcport. Defaults to '8332'."
"\n\t--datadir \t\tspecify data directory. Defaults to '~\.teos' (modifiable in conf file)." "\n\t--btcfeedconnect \tbitcoind zmq hostname (for blocks). Defaults to 'localhost'."
"\n\t--btcfeedport \t\tbitcoind zmq port (for blocks). Defaults to '28332'."
"\n\t--datadir \t\tspecify data directory. Defaults to '~\.teos'."
"\n\t-h --help \t\tshows this message." "\n\t-h --help \t\tshows this message."
) )