Skip to content

Commit bee632a

Browse files
committed
Update README
1 parent 182a861 commit bee632a

File tree

1 file changed

+22
-34
lines changed

1 file changed

+22
-34
lines changed

README.md

+22-34
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# docker-bitcoind
22

3-
[![Docker Pulls](https://badgen.net/docker/pulls/lukechilds/bitcoind?icon=docker&label=Docker%20pulls)](https://hub.docker.com/r/lukechilds/bitcoind/)
4-
[![Docker Image Size](https://badgen.net/docker/size/lukechilds/bitcoind/latest/amd64?icon=docker&label=lukechilds/bitcoind)](https://hub.docker.com/r/lukechilds/bitcoind/tags?name=latest)
5-
[![GitHub Donate](https://badgen.net/badge/GitHub/Sponsor/D959A7?icon=github)](https://github.com/sponsors/lukechilds)
6-
[![Bitcoin Donate](https://badgen.net/badge/Bitcoin/Donate/F19537?icon=bitcoin)](https://lu.ke/tip/bitcoin)
7-
[![Lightning Donate](https://badgen.net/badge/Lightning/Donate/F6BC41?icon=bitcoin-lightning)](https://lu.ke/tip/lightning)
8-
93
> Run a full Bitcoin node with one command
104
115
A Docker configuration with sane defaults for running a full Bitcoin node.
126

137
## Usage
148

159
```
16-
docker run --name bitcoind -v $HOME/.bitcoin:/data/.bitcoin -p 8333:8333 lukechilds/bitcoind
10+
docker run --name bitcoind -v $HOME/.bitcoin:/data/.bitcoin -p 8333:8333 getumbrel/bitcoind:<version-tag>
11+
```
12+
13+
Replace the tag `<version-tag>` with the available version that you want to run. For example, to run version 27.1, use the tag `v27.1`:
14+
15+
```
16+
docker run --name bitcoind -v $HOME/.bitcoin:/data/.bitcoin -p 8333:8333 getumbrel/bitcoind:v27.1
1717
```
1818

1919
### JSON-RPC
@@ -30,7 +30,7 @@ To access JSON-RPC from other services you'll also need to expose port 8332. You
3030
docker run --name bitcoind -v $HOME/.bitcoin:/data/.bitcoin \
3131
-p 8333:8333 \
3232
-p 127.0.0.1:8332:8332 \
33-
lukechilds/bitcoind
33+
getumbrel/bitcoind:v27.1
3434
```
3535

3636
You could now query JSON-RPC via cURL like so:
@@ -50,59 +50,47 @@ You can use this to configure via CLI args without a config file:
5050
docker run --name bitcoind -v $HOME/.bitcoin:/data/.bitcoin \
5151
-p 8333:8333 \
5252
-p 127.0.0.1:8332:8332 \
53-
lukechilds/bitcoind -rpcuser=jonsnow -rpcpassword=ikn0wnothin
53+
getumbrel/bitcoind:v27.1 -rpcuser=jonsnow -rpcpassword=ikn0wnothin
5454
```
5555

5656
Or just use the container like a bitcoind binary:
5757

5858
```
59-
$ docker run lukechilds/bitcoind -version
60-
Bitcoin Core Daemon version v0.18.1
61-
Copyright (C) 2009-2019 The Bitcoin Core developers
59+
$ docker run getumbrel/bitcoind:v27.1 -version
60+
Bitcoin Core RPC client version v27.1.0
61+
Copyright (C) 2009-2024 The Bitcoin Core developers
6262
6363
Please contribute if you find Bitcoin Core useful. Visit
64-
<https://bitcoincore.org> for further information about the software.
64+
<https://bitcoincore.org/> for further information about the software.
6565
The source code is available from <https://github.com/bitcoin/bitcoin>.
6666
6767
This is experimental software.
6868
Distributed under the MIT software license, see the accompanying file COPYING
6969
or <https://opensource.org/licenses/MIT>
70-
71-
This product includes software developed by the OpenSSL Project for use in the
72-
OpenSSL Toolkit <https://www.openssl.org> and cryptographic software written by
73-
Eric Young and UPnP software written by Thomas Bernard.
7470
```
7571

76-
### Version
72+
### Versions
7773

78-
Run a specific version of bitcoind if you want.
74+
Images for versions starting from v27.1 are available. To run a specific available version, use the appropriate tag.
7975

8076
```
81-
docker run --name bitcoind -v $HOME/.bitcoin:/data/.bitcoin -p 8333:8333 lukechilds/bitcoind:v0.18.1
77+
docker run --name bitcoind -v $HOME/.bitcoin:/data/.bitcoin -p 8333:8333 getumbrel/bitcoind:v27.1
8278
```
8379

8480
## Build
8581

86-
Build this image yourself by checking out this repo, `cd` ing into it and running:
82+
A multi-architecture (amd64 and arm64) image is automatically built and published to Docker Hub when new tags are pushed in the format `v*.*.*` (e.g., `v25.0.0`).
8783

88-
```
89-
docker build -t lukechilds/bitcoind .
90-
```
91-
92-
You can build a specific version by passing in the `VERSION` build arg:
84+
If you want to build this image yourself, check out this repo, `cd` into it, and run:
9385

9486
```
95-
docker build --build-arg VERSION=0.18.1 -t lukechilds/bitcoind:v0.18.1 .
87+
docker buildx build --platform linux/amd64,linux/arm64 --build-arg VERSION=<version> -t <image_name>:<tag> --push .
9688
```
9789

98-
You can build a specific architecture by passing in the `ARCH` build arg:
99-
100-
```
101-
docker build --build-arg ARCH=amd64 -t lukechilds/bitcoind:amd64 .
102-
```
90+
Replace `<version>` with the Bitcoin Core version you're building (without the 'v' prefix), and `<image_name>:<tag>` with your desired image name and tag.
10391

104-
For a full list of supported build arg options, check out the [build script matrix](https://github.com/lukechilds/docker-bitcoind/blob/master/.github/workflows/build.yml).
92+
The Dockerfile supports `linux/amd64` and `linux/arm64` architectures only.
10593

10694
## License
10795

108-
MIT © Luke Childs
96+
MIT © Umbrel, Inc. https://getumbrel.com/

0 commit comments

Comments
 (0)