feat: add docker image (#35)

Author: YoEight

.github/workflows/deploy.yml

@@ -0,0 +1,32 @@
+name: Deploy on DockerHub
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    name: Push
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.USERNAME }}
+          password: ${{ secrets.TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          platforms: linux/amd64, linux/arm64/v8
+          push: true
+          tags: yoeight/gethdb:latest

Cargo.lock

@@ -0,0 +1,49 @@
+FROM rust:slim-bookworm AS build
+
+WORKDIR /build
+COPY ./geth-common/ ./geth-common
+COPY ./geth-domain/ ./geth-domain
+COPY ./geth-engine/ ./geth-engine
+COPY ./geth-grpc/ ./geth-grpc
+COPY ./geth-mikoshi/ ./geth-mikoshi
+COPY ./geth-node/ ./geth-node
+
+WORKDIR /build/.git
+COPY ./.git/ .
+
+RUN apt update && apt install -y protobuf-compiler
+
+WORKDIR /build
+RUN cargo install --path geth-node --root /geth
+
+FROM build AS binaries
+
+ARG UID=1000
+ARG GID=1000
+
+WORKDIR /opt/gethdb
+
+RUN addgroup --gid ${GID} "geth" && \
+    adduser \
+    --disabled-password \
+    --gecos "" \
+    --ingroup "geth" \
+    --no-create-home \
+    --uid ${UID} \
+    "geth"
+
+COPY --chown=geth:geth --from=build  ./geth/bin/geth-node ./geth-node
+
+RUN mkdir -p /var/lib/gethdb && \
+    mkdir -p /var/log/gethdb && \
+    mkdir -p /etc/gethdb && \
+    chown -R geth:geth /var/lib/gethdb /var/log/gethdb /etc/gethdb
+
+USER geth
+
+VOLUME /var/lib/gethdb /var/log/gethdb
+
+EXPOSE 2113/tcp
+
+ENTRYPOINT [ "/opt/gethdb/geth-node" ]
+CMD [ "--host", "0.0.0.0", "--db", "/var/lib/gethdb" ]

Dockerfile

@@ -13,11 +13,6 @@ data structures and observe their behavior in real-life scenarios.
 This is a side project that I work on during my spare time. It is not production-ready, and most of the code is
 undocumented. Although the code is written entirely in Rust, performance is not a primary focus.
 
-## Supported platforms
-
-The codebase should compile on any 64-bit platform supported by the Rust compiler. So far, it has been tested on Linux,
-macOS, and Windows. Please note that Linux will remain the primary target
-
 ## Features
 
 The core engine is a NoSQL, append-only, and immutable database with the following key features:
@@ -30,6 +25,31 @@ The core engine is a NoSQL, append-only, and immutable database with the followi
 * Supports OpenTelemetry logs and traces, which can be sent to any OpenTelemetry-compatible server when configured, or disabled entirely if preferred.
 * Cluster functionality using a homemade Raft implementation (though it is not fully integrated yet).
 
+## Supported platforms
+
+The codebase should compile on any 64-bit platform supported by the Rust compiler. So far, it has been tested on Linux,
+macOS, and Windows. Please note that Linux will remain the primary target
+
+## Build from source
+
+You need to have the latest Rust toolchain installed and also `protoc` in your $PATH. Then run this command:
+
+```
+cargo build
+```
+
+## Docker
+
+```
+docker pull yoeight/gethdb:latest
+```
+
+At that stage, there is no other version besides `latest`. A new image is pushed every time a commit is pushed to the `master` branch.
+
+The image supports:
+- linux/amd64
+- linux/arm64/v8
+
 ## What's next?
 
 This is the features I want to work on

README.md

@@ -33,7 +33,7 @@ git = "https://github.com/YoEight/pyro.git"
 
 [dependencies.clap]
 version = "4.5"
-features = ["derive"]
+features = ["derive", "env"]
 
 [dependencies.tracing-subscriber]
 version = "0.3"

geth-engine/Cargo.toml

@@ -2,11 +2,15 @@ use clap::{Args, Parser};
 
 #[derive(Args, Debug, Clone, Default)]
 pub struct Telemetry {
-    #[arg(long = "telemetry-disabled", default_value = "false")]
+    #[arg(
+        long = "telemetry-disabled",
+        default_value = "false",
+        env = "GETH_TELEMETRY_DISABLED"
+    )]
     pub disabled: bool,
 
     /// OpenTelemetry compatible endpoint where telemetry data is sent
-    #[arg(long = "telemetry-endpoint")]
+    #[arg(long = "telemetry-endpoint", env = "GETH_TELEMETRY_ENDPOINT")]
     pub endpoint: Option<String>,
 
     #[arg(long = "telemetry-event-filters")]
@@ -19,15 +23,15 @@ pub struct Telemetry {
 #[command(propagate_version = true)]
 pub struct Options {
     /// Host IP address.
-    #[arg(long, default_value = "127.0.0.1")]
+    #[arg(long, default_value = "127.0.0.1", env = "GETH_HOST")]
     pub host: String,
 
     /// Host Port.
-    #[arg(long, default_value = "2113")]
+    #[arg(long, default_value = "2113", env = "GETH_PORT")]
     pub port: u16,
 
     /// Data directory. If you want to use the in-memory storage, set this to `in_mem`
-    #[arg(long, default_value = "./geth")]
+    #[arg(long, default_value = "./geth", env = "GETH_DB")]
     pub db: String,
 
     #[command(flatten)]

geth-engine/src/options.rs

@@ -13,5 +13,3 @@ features = ["full"]
 [dependencies]
 clap = "*"
 eyre = "0.6"
-tracing = "0.1"
-tracing-subscriber = "0.3"

geth-node/Cargo.toml

@@ -1,15 +1,7 @@
 use clap::Parser;
-use tracing::Level;
-use tracing_subscriber::FmtSubscriber;
 
 #[tokio::main]
 async fn main() -> eyre::Result<()> {
-    let subscriber = FmtSubscriber::builder()
-        .with_max_level(Level::DEBUG)
-        .finish();
-
-    tracing::subscriber::set_global_default(subscriber).expect("setting default subscriber failed");
-
     let options = geth_engine::Options::parse();
 
     geth_engine::run(options).await