enable cross building workflow

.github/workflows/client.yml

@@ -15,12 +15,63 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
+  clippy_check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+            toolchain: nightly
+            components: clippy
+            override: true
+      - uses: actions-rs/clippy-check@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --all-features
+
+  build_windows:
+    runs-on: windows-latest
+    needs: clippy_check
+    defaults:
+      run:
+        working-directory: ./
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+
+      - name: Cache Dependencies
+        uses: Swatinem/rust-cache@v2
+        with:
+          key: windows-client
+
+      - name: Build Backend
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --release
+
+      # on windows it's ./target/release/main.exe
+      # on linux it's ./target/release/main
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: x86_64-pc-windows-msvc-client.exe
+          path: ./target/release/main.exe
+
+  build_linux:
     strategy:
       matrix:
-        platform: [ubuntu-latest, windows-latest]
+        platform: [x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu]
 
-    runs-on: ${{ matrix.platform }}
+    runs-on: ubuntu-latest
+    needs: clippy_check
     defaults:
       run:
         working-directory: ./
@@ -31,22 +82,28 @@ jobs:
       - name: Install Rust toolchain
         uses: actions-rs/toolchain@v1
         with:
-          profile: minimal
           toolchain: stable
+          profile: minimal
+          override: true
+          target: ${{ matrix.platform }}
 
       - name: Cache Dependencies
         uses: Swatinem/rust-cache@v2
         with:
-          key: ${{ runner.os }}-client
+          key: ${{ matrix.platform }}-client
 
       - name: Build Backend
-        run: cargo build --verbose --release
+        uses: actions-rs/cargo@v1
+        with:
+          use-cross: true
+          command: build
+          args: --release --target ${{ matrix.platform }}
 
       # on windows it's ./target/release/main.exe
       # on linux it's ./target/release/main
 
       - name: Upload artifact
         uses: actions/upload-artifact@v2
         with:
-          name: ${{ matrix.platform }}-client${{ matrix.platform == 'windows-latest' && '.exe' || '' }}
-          path: ./target/release/${{ matrix.platform == 'windows-latest' && 'main.exe' || 'main' }}
+          name: ${{ matrix.platform }}-client
+          path: ./target/${{ matrix.platform }}/release/main

.github/workflows/release-docker.yml

@@ -0,0 +1,69 @@
+name: publish docker image
+
+on:
+  release:
+    types: [ published ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: checkout repository
+        uses: actions/checkout@v3
+      -
+        name: set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: set up docker buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: log in to the container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - 
+        id: string_tag
+        uses: ASzc/change-string-case-action@v5
+        with:
+          string: ${{ env.REGISTRY}}/${{ env.IMAGE_NAME }}
+
+      -
+        id: release_asset
+        name: Download release assets
+        uses: dsaltares/fetch-gh-release-asset@master
+        with:
+          regex: true
+          file: "lodestone_core_.*"
+          target: release/
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      -
+        name: build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/amd64
+          file: ./githubactions.Dockerfile
+          build-args: |
+            binpath=./target/lodestone_core_${{ steps.release_asset.outputs.version }}
+          push: true
+          tags: ${{ steps.string_tag.outputs.lowercase }}:latest,${{ steps.string_tag.outputs.lowercase }}:${{ steps.release_asset.outputs.version }}
+
+      -
+        name: build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/arm64
+          file: ./githubactions.Dockerfile
+          build-args: |
+            binpath=./target/lodestone_core_arm_${{ steps.release_asset.outputs.version }}
+          push: true
+          tags: ${{ steps.string_tag.outputs.lowercase }}:latest,${{ steps.string_tag.outputs.lowercase }}:${{ steps.release_asset.outputs.version }}

Cargo.toml

@@ -82,6 +82,7 @@ ts-rs = "6.2.1"
 walkdir = "2.3.2"
 whoami = "1.2.3"
 zip = "0.6.2"
+openssl = { version = "0.10.45", features = ["vendored"] }
 flate2 = "1.0.24"
 tar = "0.4.38"
 unrar = "0.4.4"

Cross.toml

@@ -0,0 +1,5 @@
+[target.x86_64-unknown-linux-gnu]
+pre-build = ["apt-get update && apt-get install --assume-yes libssl-dev libsasl2-dev"]
+
+[target.aarch64-unknown-linux-gnu]
+pre-build = ["dpkg --add-architecture arm64 && apt-get update && apt-get install --assume-yes libssl-dev libssl-dev:arm64 libsasl2-dev"]

README.md

@@ -73,6 +73,26 @@
 
 Follow the instruction on our [Github page](https://github.com/Lodestone-Team#installation)
 
+### Using Docker Image
+
+As of v0.4.3 we have added Docker support to lodestone core.
+Our precompiled images will be based on the newest release available from: `ghcr.io/lodestone-team/lodestone_core`.
+Alternatively, you may build your own image using the default `Dockerfile`, not additional arguments required.
+
+> **Note**
+> You may add additional ports as you wish to forward, but 16662 is the default port served in the image.
+> You may add a volume for your lodestone instance to be accessible, in the example below, you can create a volume first by using `docker volume create lodestone`.
+
+To use:
+```sh
+docker run -d \
+  --name lodestone \
+  --restart unless-stopped \
+  -p 16662:16662 \
+  -v lodestone:/root/.lodestone \
+  ghcr.io/Lodestone-Team/lodestone_core
+```
+
 <!-- GETTING STARTED -->
 ## Getting Started (development)
 

githubactions.Dockerfile

@@ -0,0 +1,28 @@
+# syntax=docker/dockerfile:1
+FROM debian:bullseye-slim as production
+
+ARG binpath=./release/main
+
+#
+RUN apt-get update \
+  && apt-get install -y ca-certificates libssl-dev libsasl2-dev \
+  && update-ca-certificates \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN ldconfig
+
+RUN echo $LD_LIBRARY_PATH
+
+# create and enter app directory
+WORKDIR /app
+
+COPY $binpath ./main
+
+# specify default port
+EXPOSE 16662
+
+# specify persistent volume
+VOLUME ["/root/.lodestone"]
+
+# start lodestone_core
+CMD ["./main"]