bitcoin-core-container/README.org

#+title: Bitcoin Core Container

* About

This project builds images of [[https://github.com/bitcoin/bitcoin][Bitcoin Core]] for use as [[https://podman.io/][Podman]] or [[https://www.docker.com/][Docker]] containers. It has support for the following platforms:

- =amd64=
- =arm64=
- =arm32v7=

#+begin_quote
The examples in this document use the ~podman~ command. Just swap with the ~docker~ command if you are using Docker.
#+end_quote

* Usage

#+begin_quote
*IMPORTANT:* It is recommended that you pin the image using the major version tags (ie. =24=, =25=). This way, a manual change is required before updating the service to the next major version. You can use this time to make backups in case something goes wrong.

The =latest= tag always points to the latest version. So it has a higher chance of introducing a breaking change by accident. Only use =latest= if you like living on the edge.
#+end_quote

To run a container, use either ~podman run~ or define a service in a =compose.yaml= file.

** Run

To run with ~podman run~:

#+begin_src shell
podman run -v ./bitcoin:/home/bitcoin/.bitcoin -p 8333:8333 code.fosterhangdaan.com/foster/bitcoin-core-container:25
#+end_src

** Compose

To define a service in a =compose.yaml= file:

#+begin_src yaml
version: "3.8"

services:
  bitcoin-core:
   image: code.fosterhangdaan.com/foster/bitcoin-core-container:25
   container_name: bitcoin-core
   restart: unless-stopped
   volumes:
     - ./bitcoin:/home/bitcoin/.bitcoin
   ports:
     # RPC
     - 8332:8332
     # P2P
     - 8333:8333
     # ZMQ block notifications
     - 28332:28332
     # ZMQ transaction notifications
     - 28333:28333
#+end_src

* Building

To build the image:

#+begin_src shell
podman build --platform='linux/amd64' .
#+end_src

Set the os/arch of the built image with the ~--platform~ option. It accepts one of the following values:

- =linux/amd64= :: for =amd64=
- =linux/arm64= :: for =arm64=
- =linux/arm/v7= :: for =arm32v7=

* Contributing

Please send patches and bug reports by email to one of the maintainers. See the *Core Maintainers* section for a list of contacts.

Refer to [[https://git-send-email.io][this guide]] if you are not familiar with sending Git patches over email.

* Core Maintainers

- *Foster Hangdaan*
  - Website: [[https://www.fosterhangdaan.com][www.fosterhangdaan.com]]
  - Email: [[mailto:foster@hangdaan.email][foster@hangdaan.email]]
  - GPG Public Key: [[https://static.fosterhangdaan.com/foster-pubkey.asc][DBD3 8E38 4B9E 1F4F 19F9 5BAE E48D 7F49 A852 F112]]
  - OpenAlias: =pay.fosterhangdaan.com=

* License

Licensed under the Apache License, Version 2.0. See =LICENSE.txt=.

* Copyright

Copyright 2023 Foster Hangdaan