2022 01 12 docker ws (#3976)

* Add port 19999 to bitcoin-s-server exposed ports, Add port 19999 to documentation

* Get docker containers working correctly with websockets

Co-authored-by: Ivan <erickson.ivan@gmail.com>
This commit is contained in:
Chris Stewart 2022-01-12 14:07:11 -06:00 committed by GitHub
parent 9dd126bb9f
commit e24efd65ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 5 deletions

View File

@ -13,7 +13,7 @@ packageSummary := "A Bitcoin neutrino node and wallet"
packageDescription := "Runs a Bitcoin neutrino node and wallet, has functionality " +
"for many different modes and configuration options, see more at https://bitcoin-s.org/docs/applications/server"
dockerExposedPorts ++= Seq(9999)
dockerExposedPorts ++= Seq(9999, 19999)
dockerEntrypoint := Seq("/opt/docker/bin/bitcoin-s-server")

View File

@ -9,6 +9,8 @@ bitcoin-s.node.peers = ${?BITCOIN_S_NODE_PEERS}
# have host machine forward requests to the docker container
bitcoin-s.server.rpcbind = "0.0.0.0"
bitcoin-s.server.rpcbind = ${?BITCOIN_S_RPC_BIND}
bitcoin-s.server.wsbind= "0.0.0.0"
bitcoin-s.server.wsbind= ${?BITCOIN_S_WS_BIND}
bitcoin-s.bitcoind-rpc.rpcconnect = ${?BITCOIN_S_BITCOIND_HOST}
bitcoin-s.bitcoind-rpc.rpcport = ${?BITCOIN_S_BITCOIND_PORT}

View File

@ -57,13 +57,13 @@ docker build app/server/target/docker/stage/ -t bitcoin-s-server:latest
Finally, let's run the image! It's important that you correctly configure port forwarding with the docker container so
you can interact with the running container with `bitcoin-s-cli` or `curl`. By default, our oracle
server listens for requests on port `9999`.
server listens for requests on port `9999`. By default, the server listens for websocket connections on port `19999` at `/events`.
This means we need to forward requests on the host machine to the docker container correctly.
This can be done with the following command
```
docker run -d -p 9999:9999 bitcoin-s-server:latest
docker run -d -p 9999:9999 -p 19999:19999 bitcoin-s-server:latest
```
Now you can send requests with `bitcoin-s-cli` or `curl`.
@ -96,6 +96,12 @@ You can also pass in a custom `rpcport` to bind to
./app/server/target/universal/stage/bin/bitcoin-s-server --rpcport 12345
```
Or set a custom `wsport` to bind to
```bash
./app/server/target/universal/stage/bin/bitcoin-s-server --wsport 54321
```
For more information on configuring the server please see our [configuration](../config/configuration.md) document
For more information on how to use our built in `cli` to interact with the server please see [cli.md](cli.md)
@ -111,7 +117,7 @@ You can use bitcoin-s with docker volumes. You can also pass in a custom configu
```basrc
docker volume create bitcoin-s
docker run -p 9999:9999 \
docker run -p 9999:9999 -p 19999:19999 \
--mount source=bitcoin-s,target=/home/bitcoin-s/ bitcoinscala/bitcoin-s-server:latest
```
@ -128,7 +134,7 @@ the default one we provide [here](https://github.com/bitcoin-s/bitcoin-s/blob/ma
You can do this with the following command
```bashrc
docker run -p 9999:9999 \
docker run -p 9999:9999 -p 19999:19999 \
--mount type=bind,source=/my/new/config/,target=/home/bitcoin-s/.bitcoin-s/ \
bitcoinscala/bitcoin-s-server:latest --conf /home/bitcoin-s/.bitcoin-s/bitcoin-s.conf
```