Merge remote-tracking branch 'github-pull/115/head' (feat: Add Dockerfile)

Author: luke-jr

Dockerfile

@@ -0,0 +1,73 @@
+FROM debian:bookworm-slim AS builder
+
+# Install dependencies for building
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    cmake \
+    gcc \
+    pkg-config \
+    libjansson-dev \
+    libmicrohttpd-dev \
+    libsodium-dev \
+    libcurl4-openssl-dev \
+    git \
+    --no-install-recommends \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /build
+
+# Copy entire repository for git information
+COPY . .
+
+# Build the application with optimization flags
+RUN cmake -DCMAKE_BUILD_TYPE=Release . && make -j$(nproc)
+
+# Use the same Debian version for runtime to ensure library compatibility
+FROM debian:bookworm-slim AS runtime
+
+# Install only runtime dependencies
+RUN apt-get update && apt-get install -y \
+    libjansson4 \
+    libmicrohttpd12 \
+    libsodium23 \
+    libcurl4 \
+    netcat-traditional \
+    --no-install-recommends \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* \
+    && rm -rf /usr/share/doc /usr/share/man \
+    && find /var/cache -type f -delete
+
+WORKDIR /app
+
+# Copy only the built binary and necessary files from builder
+COPY --from=builder /build/datum_gateway /app/
+COPY --from=builder /build/www/ /app/www/
+COPY --from=builder /build/doc/example_datum_gateway_config.json /app/config/config.json
+
+# Create a configuration directory if it doesn't exist
+RUN mkdir -p /app/config
+
+# Verify shared library dependencies
+RUN ldd /app/datum_gateway
+
+# Create a non-root user
+RUN useradd -r -s /bin/false datumuser && \
+    chown -R datumuser:datumuser /app
+
+# Change to non-root user
+USER datumuser
+
+# Set up healthcheck
+HEALTHCHECK --interval=30s --timeout=5s --start-period=5s --retries=3 \
+  CMD nc -zv localhost 23334 || exit 1
+
+# Expose ports
+EXPOSE 23334/tcp 7152/tcp
+
+# Create a volume for configuration and data
+VOLUME ["/app/config"]
+
+# Set the entrypoint
+ENTRYPOINT ["/app/datum_gateway", "--config", "/app/config/config.json"]

README.md

@@ -140,6 +140,124 @@ Note that the API/web admin password is also used for preventing CSRF attacks, s
 You should review the [documentation on usernames](doc/usernames.md) next.
 Once you have everything running, you can point miners at the Gateway.
 
+## Docker
+
+The DATUM Gateway is also available as a Docker image.
+
+
+### Building the Docker Image
+
+To build the DATUM Gateway Docker image:
+
+```bash
+# From the root of the repository
+docker build -t datum_gateway .
+```
+
+### Running the Container
+
+To run the DATUM Gateway container:
+
+```bash
+# Run with default configuration
+docker run -p 23334:23334 -p 7152:7152 --name datum-gateway datum_gateway
+```
+
+The container expects a configuration file at `/app/config/config.json`. Mount a volume to this path to use your own configuration:
+
+```bash
+docker run -v /path/to/your/config/directory:/app/config -p 23334:23334 -p 7152:7152 datum_gateway
+```
+
+You will need to disable the notify fallback in your configuration file if you are using Docker. And in bitcoin.conf, you will need to set the following:
+
+```bash
+blocknotify=wget -q -O /dev/null http://datum-gateway:7152/NOTIFY
+```
+
+### Connecting to a Bitcoin Node
+
+When running the DATUM Gateway in Docker, you need to configure it to connect to your Bitcoin node. The connection method depends on where your Bitcoin node is running:
+
+#### 1. Bitcoin Node Running in Docker (Same Network)
+
+If your Bitcoin node is also running in a Docker container on the same network, use the container name as the hostname:
+
+```json
+{
+  "rpc_host": "bitcoin-node",
+  "rpc_port": 8332,
+  "rpc_user": "your_rpc_user",
+  "rpc_pass": "your_rpc_password"
+}
+```
+
+In your `bitcoin.conf`, set the blocknotify to use the DATUM Gateway container name:
+
+```
+blocknotify=wget -q -O /dev/null http://datum-gateway:7152/NOTIFY
+```
+
+#### 2. Bitcoin Node Running on Host System
+
+If your Bitcoin node is running directly on the host system or in a container that binds to host ports, you have two options:
+
+**Option A: Using host.docker.internal (recommended)**
+```json
+{
+  "rpc_host": "host.docker.internal",
+  "rpc_port": 8332,
+  "rpc_user": "your_rpc_user",
+  "rpc_pass": "your_rpc_password"
+}
+```
+
+**Option B: Using host networking mode**
+Run the DATUM Gateway container with `--network host`:
+
+```bash
+docker run --network host -v /path/to/config:/app/config datum_gateway
+```
+
+Then configure using localhost:
+```json
+{
+  "rpc_host": "localhost",
+  "rpc_port": 8332,
+  "rpc_user": "your_rpc_user",
+  "rpc_pass": "your_rpc_password"
+}
+```
+
+For blocknotify in `bitcoin.conf` when using host networking:
+```
+blocknotify=wget -q -O /dev/null http://localhost:7152/NOTIFY
+```
+
+#### 3. Bitcoin Node on Remote System
+
+If your Bitcoin node is running on a different machine, use the hostname or IP address:
+
+```json
+{
+  "rpc_host": "192.168.1.100",
+  "rpc_port": 8332,
+  "rpc_user": "your_rpc_user",
+  "rpc_pass": "your_rpc_password"
+}
+```
+
+In your remote Bitcoin node's `bitcoin.conf`:
+```
+blocknotify=wget -q -O /dev/null http://datum-gateway-host-ip:7152/NOTIFY
+```
+
+**Important Notes:**
+- Ensure your Bitcoin node's RPC is configured to accept connections from the DATUM Gateway
+- For remote connections, you may need to configure `rpcbind` and `rpcallowip` in your `bitcoin.conf`
+- Always use strong RPC credentials and consider network security when exposing RPC endpoints
+- Remember to disable the notify fallback in your DATUM Gateway configuration when using Docker
+
 ## Template/Share Requirements for Pooled Mining
 
  - Must be a valid block and conform to current Bitcoin consensus rules