Merge pull request #208 from guggero/docker

Add Dockerfile to prepare for packaging as Umbrel app

Author: guggero

Dockerfile

@@ -0,0 +1,45 @@
+# Start with a Golang builder image.
+FROM golang:1.24.6-alpine3.22@sha256:c8c5f95d64aa79b6547f3b626eb84b16a7ce18a139e3e9ca19a8c078b85ba80d AS golangbuilder
+
+# Pass a tag, branch or a commit using build-arg. This allows a docker image to
+# be built from a specified Git state.
+ARG checkout="master"
+
+# Install dependencies and install/build chantools.
+RUN apk add --no-cache --update alpine-sdk make \
+  && git clone https://github.com/lightninglabs/chantools /go/src/github.com/lightninglabs/chantools \
+  && cd /go/src/github.com/lightninglabs/chantools \
+  && git checkout $checkout \
+  && make install
+
+# Start a new, final image to reduce size.
+FROM alpine:3.22.1@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1 AS final
+
+# Define a root volume for data persistence.
+VOLUME /chantools
+WORKDIR /chantools
+
+# We'll use the default / directory as the home directory, since the /chantools
+# folder will be overwritten if a volume is mounted there.
+ENV HOME=/
+
+# We'll expect the lnd data directory to be mounted here.
+VOLUME /lnd
+
+# Copy the binaries and entrypoint from the builder image.
+COPY ./docker/docker-entrypoint.sh /bin/
+COPY ./docker/bash-wrapper.sh /usr/local/bin/bash
+COPY --from=golangbuilder /go/bin/chantools /bin/
+
+# Make the wrapper executable.
+RUN chmod 0777 /usr/local/bin/bash
+
+# Add bash.
+RUN apk add --no-cache \
+  bash \
+  jq \
+  ca-certificates
+
+# We'll want to just start a shell, but also give the user some info on how to
+# use this image, which we do with a shell script.
+ENTRYPOINT ["/bin/docker-entrypoint.sh"]

Makefile

@@ -81,6 +81,10 @@ release:
 	rm -rf chantools-v*
 	./release.sh build-release "$(VERSION_TAG)" "$(BUILD_SYSTEM)" "$(RELEASE_LDFLAGS)"
 
+docker-release:
+	@$(call print, "Creating docker release of chantools.")
+	./release.sh docker-release "$(VERSION_TAG)"
+
 docker-tools:
 	@$(call print, "Building tools docker image.")
 	docker build -q -t chantools-tools $(TOOLS_DIR)

docker/bash-wrapper.sh

@@ -0,0 +1,17 @@
+ #!/bin/bash
+ 
+echo "Welcome to the chantools command line interface."
+echo "Type 'chantools --help' (without quotes) to see available commands."
+echo ""
+echo "You might also want to visit https://www.node-recovery.com/chantools/"
+echo "for the reference documentation and an interactive tool that helps you"
+echo "build the command you might want to run."
+echo ""
+echo "Also, keep in mind that you don't have to run chantools inside this"
+echo "container. You can also install it directly on any machine you want,"
+echo "since there is no direct interaction with your Lightning node required"
+echo "and for most command you don't even need anything other than your seed"
+echo "phrase."
+echo ""
+
+exec /bin/bash

docker/docker-entrypoint.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+echo "Starting background shell, this container doesn't do anything on its own."
+echo "You can connect to it using: docker exec -it <container_name> bash"
+
+sleep infinity

release.sh

@@ -10,6 +10,7 @@
 set -e
 
 PKG="github.com/lightninglabs/chantools"
+DOCKER_USER="guggero"
 PACKAGE=chantools
 
 # green prints one line of green text (if the terminal supports it).
@@ -79,6 +80,13 @@ function build_release() {
   shasum -a 256 * >manifest-$tag.txt
 }
 
+# docker_release builds the Docker images for all supported platforms.
+#   arguments: <version-tag>
+function docker_release() {
+  local tag=$1
+  docker buildx build --platform linux/arm64,linux/amd64 --tag $DOCKER_USER/$PACKAGE:$tag --output "type=registry" .
+}
+
 # usage prints the usage of the whole script.
 function usage() {
   red "Usage: "
@@ -103,6 +111,10 @@ build-release)
   green "Building release"
   build_release "$@"
   ;;
+docker-release)
+  green "Building docker release"
+  docker_release "$@"
+  ;;
 *)
   usage
   exit 1