diff --git a/README.md b/README.md index 98df6a7..02c23a6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,40 @@ # Docker Knots -Docker images for [Bitcoin Knots](https://bitcoinknots.org/) +Docker images of [Bitcoin Knots](https://bitcoinknots.org/) for the `linux/amd64`, `linux/arm64` and `linux/arm/v7` architectures. + +The images are based on [Alpine Linux](https://alpinelinux.org/) and run bitcoind without a configuration file. + +The datadir is at the default `/home/bitcoin/.bitcoin` location. +This directory is designated as a Docker volume. + +These are the images' default `ENTRYPOINT` and `CMD`, respectively. +Adjust the `CMD` as required if you want to run the bitcoind daemon with a different configuration. + +```dockerfile +ENTRYPOINT ["/usr/local/bin/bitcoind", "-nodebuglogfile"] + +CMD ["-zmqpubrawblock=tcp://0.0.0.0:28332", "-zmqpubrawtx=tcp://0.0.0.0:28333"] +``` + +Customization example based on Docker Compose v2: + +```yaml +name: knots-signet + +services: + knots: + image: 1maa/bitcoin:v26.1.knots20240325 + command: -signet -txindex=1 -zmqpubrawblock=tcp://0.0.0.0:28332 -zmqpubrawtx=tcp://0.0.0.0:28333 +``` + + +## Available Versions + +* 1maa/bitcoin:v25.1.knots20231115 +* 1maa/bitcoin:v26.1.knots20240325 + + +## Deterministic Build Guide + +The binaries contained in these images are built from source automatically with GitHub actions, but they are not deterministic. +For a step-by-step guide to do a deterministic build of Bitcoin Knots and attest the resulting binaries with you PGP key, check *TBD*. diff --git a/v25.1.knots20231115/Dockerfile b/v25.1.knots20231115/Dockerfile index 04bc08c..7b18fa5 100644 --- a/v25.1.knots20231115/Dockerfile +++ b/v25.1.knots20231115/Dockerfile @@ -86,7 +86,7 @@ EXPOSE 8333 18333 18444 38333 # RPC interface (mainnet, testnet, regtest & signet respectively) EXPOSE 8332 18332 18443 38332 -# ZMQ ports (for transactions & blocks respectively) +# ZMQ ports (for blocks & transactions respectively) EXPOSE 28332 28333 ENTRYPOINT ["/usr/local/bin/bitcoind", "-nodebuglogfile"] diff --git a/v26.1.knots20240325/Dockerfile b/v26.1.knots20240325/Dockerfile index 27954b9..c2c87ab 100644 --- a/v26.1.knots20240325/Dockerfile +++ b/v26.1.knots20240325/Dockerfile @@ -86,7 +86,7 @@ EXPOSE 8333 18333 18444 38333 # RPC interface (mainnet, testnet, regtest & signet respectively) EXPOSE 8332 18332 18443 38332 -# ZMQ ports (for transactions & blocks respectively) +# ZMQ ports (for blocks & transactions respectively) EXPOSE 28332 28333 ENTRYPOINT ["/usr/local/bin/bitcoind", "-nodebuglogfile"]