Merge pull request #89 from jollySleeper/workflow

Workflow for Docker Images

.github/workflows/container-release.yml

@@ -0,0 +1,56 @@
+name: Docker Image CI
+
+on:
+  push:
+    tags:
+      - 'v*'  # This will trigger the workflow on tags that start with 'v'
+
+env:
+  REGISTRY: ghcr.io
+  USER: ${{ github.repository_owner }}
+  IMAGE_NAME: ${{ github.repository }}
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  build-push:
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Check Out Repo
+      uses: actions/checkout@v4
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+      with:
+        # arm64 specific
+        platforms: arm64
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Login to registry
+      uses: docker/login-action@v3
+      with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ env.USER }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Extract metadata (tags, labels) for Docker
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+    - name: Build and push Docker image
+      uses: docker/build-push-action@v6
+      with:
+        context: .
+        push: true
+        file: ./Dockerfile
+        platforms: linux/amd64,linux/arm64
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -164,6 +164,23 @@ Change the docker-compose file to your liking and run `docker-compose up -d` to
 
 ### Docker (Built)
 
+Use the pre-built images from github packages using `docker pull ghcr.io/zyachel/libremdb:latest` to pull latest images.
+
+To run the container with pulled image use the following command.
+> Note: Env file is required for running this image. Download and edit this [env file](https://github.com/zyachel/libremdb/blob/main/.env.local.example).
+
+
+```sh 
+docker/podman run \
+ --detach \
+ --name "libremdb" \
+ -p 3000:3000 \
+ --env-file "path_to_env_file" \
+ ghcr.io/zyachel/libremdb:latest
+```
+
+OR 
+
 There's a [docker image](https://github.com/PussTheCat-org/docker-libremdb-quay) made by [@TheFrenchGhosty](https://github.com/TheFrenchGhosty) for [PussTheCat.org's instance](https://libremdb.pussthecat.org). You can use that as well.
 
 ## Miscellaneous