Browse Source

Merge pull request #6 from timroemisch/master

docker image and automated build
Matt Clark 8 months ago
parent
commit
79366e9f34
3 changed files with 90 additions and 0 deletions
  1. 63 0
      .github/workflows/docker-publish.yml
  2. 19 0
      Dockerfile
  3. 8 0
      README.md

+ 63 - 0
.github/workflows/docker-publish.yml

@@ -0,0 +1,63 @@
+name: Docker
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  schedule:
+    - cron: '29 3 5 * *'
+  push:
+    branches: [ master ]
+    # Publish semver tags as releases.
+    tags: [ 'v*.*.*' ]
+  pull_request:
+    branches: [ master ]
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@28218f9b04b4f3f62068d7b6ce6ca5b26e35336c
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

+ 19 - 0
Dockerfile

@@ -0,0 +1,19 @@
+
+# Build stage 
+FROM maven:3-openjdk-11-slim AS build
+COPY src /home/app/src
+COPY pom.xml /home/app
+RUN mvn clean compile assembly:single -f /home/app/pom.xml 
+
+# Package stage
+FROM openjdk:11-jre-slim
+RUN apt update && apt install -y libfreetype-dev && rm -rf /var/lib/apt/lists/*
+COPY --from=build /home/app/target/server.jar /usr/local/lib/server.jar
+COPY config /config
+COPY resources /resources
+
+VOLUME /config
+
+EXPOSE 8080
+CMD ["java","-jar","/usr/local/lib/server.jar"]
+

+ 8 - 0
README.md

@@ -34,6 +34,14 @@ curl https://barcodeapi.org/api/128/abc123
 curl https://barcodeapi.org/api/qr/abc123
 ```
 
+#### Docker Container
+
+To build the image run:  
+`docker build -t barcodeAPIServer .`  
+
+And to run the container:  
+`docker run -p 8080:8080 -v $(pwd)/config:/config barcodeAPIServer`
+
 ## Third-Party
 
 BarcodeAPI.org is only made possible with the use of third-party software.