feat: move ord to layer 1 ordinals dir

Author: geekwho-eth

.github/workflows/ord.yaml renamed to .github/workflows/ordinals.yaml

@@ -22,7 +22,7 @@ jobs:
           #- name: ord-alpine
           #  context: "./ord/alpine"
           - name: ord-ubuntu
-            context: "./ord/ubuntu"
+            context: "./layer1/ordinals/ord/ubuntu"
     steps:
       - name: Checkout
         uses: actions/checkout@v4

layer1/ordinals/ord/README.md

@@ -0,0 +1,71 @@
+# An Ordinals ORD Docker Image
+
+This Docker image is built to run Bitcoin Core and ord.
+
+# An Ordinals ORD Tags
+- `ord-alpine` ([ord/Dockerfile](https://github.com/geekwho-eth/docker-bitcoin-core/blob/master/ord/Dockerfile))
+
+ord build by ordinals install.sh.
+
+## Features
+
+- Utilizes Alpine Linux for a lightweight base image.
+- Non-root user (`ord`) for enhanced security.
+- Automatic installation of required dependencies.
+- Includes `libevent` and `libzmq` for improved performance.
+- Supports configuration via `ord.yaml`.
+- Exposes port `8080` for HTTP communication.
+
+## Usage
+
+1. **Build Image**:
+
+   ```bash
+   docker build -t ord-alpine .
+   ```
+
+2. **Run Bitcoin Core**:
+
+   ```bash
+   docker run -d --name ord-alpine \
+       -v /path/to/:/home/ord/ \
+       -p 8080:8080 \
+       ord-alpine ord --config=/home/ord/ord.yaml --rpc-url=127.0.0.1:8332 server --http-port=8080
+   ```
+
+3. **Environment Variables**:
+
+   - `UID`: User ID (default: `100`).
+   - `GID`: Group ID (default: `101`).
+   - `ORD_YAML`: Path to `ord.yaml` (default: `/home/ord/ord.yaml`).
+   - `ORD_USER`: User name (default: `ord`).
+   - `ORD_RPC_URL`: RPC URL (default: `127.0.0.1:8332`).
+
+4. **Configuration**:
+
+   Modify `ord.yaml` as per your requirements.
+
+5. **Access Web Interface**:
+
+   Open your browser and go to `http://localhost:8080`.
+
+6. **Additional Information**:
+
+   - [Bitcoin Core Documentation](https://bitcoin.org/en/bitcoin-core/)
+   - [Ordinals GitHub Repository](https://github.com/ordinals/ord)
+
+## Maintenance
+
+For any issues or feedback, please contact the maintainer:
+
+- Maintainer: GeekWho
+- Email: [email protected]
+
+## Version Information
+
+- Docker Image Version: 1.0
+- Bitcoin Core Version: [Specify Version]
+
+## License
+
+[MIT License](../LICENSE)

layer1/ordinals/ord/alpine/Dockerfile

@@ -0,0 +1,63 @@
+# Build stage for builder
+FROM alpine as builder
+
+RUN sed -i 's/http\:\/\/dl-cdn.alpinelinux.org/https\:\/\/alpine.global.ssl.fastly.net/g' /etc/apk/repositories
+RUN apk --no-cache add autoconf automake build-base libressl bash curl
+
+# install.sh
+ENV ORD_INSTALL_SH="https://raw.githubusercontent.com/ordinals/ord/master/install.sh"
+
+ARG TARGETPLATFORM
+ENV TARGET=x86_64-unknown-linux-gnu
+
+RUN wget ${ORD_INSTALL_SH} && chmod +x install.sh \
+  && if [ "${TARGETPLATFORM}" = "linux/arm64" ]; then export TARGET=aarch64-apple-darwin; fi \
+  && ./install.sh --to /usr/local/bin --target ${TARGET}
+
+# Build stage for compiled artifacts
+FROM alpine
+
+# Map host user uid and gid
+ARG HOST_UID=100
+ARG HOST_GID=101
+
+ENV USER_HOME=/home/ord/
+ENV USER_NAME=ord
+ENV USER_GROUP=ord
+ENV BITCOIN_RPC_LISTEN=127.0.0.1:8332
+
+LABEL maintainer="GeekWho <[email protected]>"
+LABEL version="1.0"
+LABEL description="An Ordinals ORD docker image"
+
+RUN addgroup ${USER_GROUP} --gid ${HOST_GID} --system
+RUN adduser --uid ${HOST_UID} --system ${USER_NAME} --ingroup ${USER_GROUP}
+RUN sed -i 's/http\:\/\/dl-cdn.alpinelinux.org/https\:\/\/alpine.global.ssl.fastly.net/g' /etc/apk/repositories
+RUN apk --no-cache add \
+  libevent \
+  libzmq \
+  shadow \
+  sqlite-dev \
+  su-exec
+
+# fix glibc not work on alpine
+ENV GLIBC_REPO=https://github.com/sgerrand/alpine-pkg-glibc
+ENV GLIBC_VERSION=2.35-r1
+RUN set -ex && \
+    apk --update add libstdc++ curl ca-certificates && \
+    for pkg in glibc-${GLIBC_VERSION} glibc-bin-${GLIBC_VERSION}; \
+        do curl -sSL ${GLIBC_REPO}/releases/download/${GLIBC_VERSION}/${pkg}.apk -o /tmp/${pkg}.apk; done && \
+    apk add --allow-untrusted /tmp/*.apk && \
+    rm -v /tmp/*.apk && \
+    /usr/glibc-compat/sbin/ldconfig /lib /usr/glibc-compat/lib
+
+COPY --from=builder /usr/local/bin/ord /usr/local/bin/
+COPY docker-entrypoint.sh /entrypoint.sh
+
+VOLUME ["$USER_HOME"]
+
+EXPOSE 8080
+
+ENTRYPOINT ["/entrypoint.sh"]
+
+CMD ["ord"]

layer1/ordinals/ord/alpine/docker-entrypoint.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+set -e
+
+# Check if HOST_UID is set and not 0
+if [ -n "${HOST_UID+x}" ] && [ "${HOST_UID}" != "0" ]; then
+  usermod -u "$HOST_UID" $USER_NAME # Change the user ID to HOST_UID
+fi
+
+# Check if HOST_GID is set and not 0
+if [ -n "${HOST_GID+x}" ] && [ "${HOST_GID}" != "0" ]; then
+  if grep -q ":$HOST_GID:" /etc/group; then # if group exists
+    usermod -a -G $HOST_GID $USER_NAME # Add USER_NAME to Group ID HOST_GID
+  else
+    groupmod -g "$HOST_GID" $USER_NAME # Change the group ID to HOST_GID
+  fi
+fi
+
+echo "$0: assuming uid:gid for ${USER_NAME}:${USER_NAME} of $(id -u $USER_NAME):$(id -g $USER_NAME)"
+
+# Get the home directory of $USER_NAME
+home_dir=$(getent passwd $USER_NAME | cut -d: -f6)
+# Change ownership of the home directory
+chown -R $USER_NAME:$HOST_GID ${home_dir}
+echo "reset home dir permissions for user ${USER_NAME}:${HOST_GID} done."
+echo "start ${USER_NAME} with user ${USER_NAME}..."
+exec su-exec $USER_NAME:$HOST_GID "$@" # Execute the command with the specified user

layer1/ordinals/ord/ubuntu/Dockerfile

@@ -0,0 +1,51 @@
+FROM ubuntu:23.04 as builder
+
+LABEL maintainer="GeekWho <[email protected]>"
+LABEL version="1.0"
+LABEL description="A bitcoin-core docker image"
+
+RUN apt-get update -y \
+  && apt-get install -y ca-certificates wget curl --no-install-recommends \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# install.sh
+ARG ORD_INSTALL_SH="https://raw.githubusercontent.com/ordinals/ord/master/install.sh"
+# default ENV
+ARG TARGETPLATFORM
+ENV TARGET=x86_64-unknown-linux-gnu
+
+RUN wget ${ORD_INSTALL_SH} && chmod +x install.sh \
+  && if [ "${TARGETPLATFORM}" = "linux/arm64" ]; then export TARGET=aarch64-apple-darwin; fi \
+  && ./install.sh --to /usr/local/bin --target ${TARGET}
+
+# Second stage
+FROM ubuntu:23.04
+
+# Map host user uid and gid
+ARG HOST_UID=100
+ARG HOST_GID=101
+
+ENV USER_HOME=/home/ord/
+ENV USER_NAME=ord
+ENV USER_GROUP=ord
+ENV BITCOIN_RPC_LISTEN=127.0.0.1:8332
+
+RUN groupadd --gid ${HOST_GID} ${USER_GROUP} \
+  && useradd --create-home --no-log-init -u ${HOST_UID} -g ${HOST_GID} ${USER_NAME} \
+  && apt-get update -y \
+  && apt-get install -y gosu curl --no-install-recommends \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+COPY --from=builder /usr/local/bin/ord /usr/local/bin/
+
+COPY docker-entrypoint.sh /entrypoint.sh
+
+VOLUME ["$USER_HOME"]
+
+EXPOSE 8080
+
+ENTRYPOINT ["/entrypoint.sh"]
+
+CMD ["ord"]

layer1/ordinals/ord/ubuntu/docker-entrypoint.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+set -e
+
+# Check if HOST_UID is set and not 0
+if [ -n "${HOST_UID+x}" ] && [ "${HOST_UID}" != "0" ]; then
+  usermod -u "$HOST_UID" $USER_NAME # Change the user ID to HOST_UID
+fi
+
+# Check if HOST_GID is set and not 0
+if [ -n "${HOST_GID+x}" ] && [ "${HOST_GID}" != "0" ]; then
+  if grep -q ":$HOST_GID:" /etc/group; then # if group exists
+    usermod -a -G $HOST_GID $USER_NAME # Add USER_NAME to Group ID HOST_GID
+  else
+    groupmod -g "$HOST_GID" $USER_NAME # Change the group ID to HOST_GID
+  fi
+fi
+
+echo "$0: assuming uid:gid for ${USER_NAME}:${USER_NAME} of $(id -u $USER_NAME):$(id -g $USER_NAME)"
+
+# Get the home directory of $USER_NAME
+home_dir=$(getent passwd $USER_NAME | cut -d: -f6)
+# Change ownership of the home directory
+chown -R $USER_NAME:$HOST_GID ${home_dir}
+echo "reset home dir permissions for user ${USER_NAME}:${HOST_GID} done."
+echo "start ${USER_NAME} with user ${USER_NAME}..."
+exec gosu $USER_NAME:$HOST_GID "$@" # Execute the command with the specified user