Merge pull request #17 from teynar/feat/dockerize-app

Dockerize application

Author: Stream29

.dockerignore

@@ -0,0 +1,13 @@
+# IDE files
+.run/
+
+# Gradle files and caches
+.gradle/
+build/
+
+# VCS
+.git
+.gitignore
+
+# Tests
+src/test/

Dockerfile

@@ -0,0 +1,27 @@
+FROM eclipse-temurin:21-jdk-alpine AS build
+
+WORKDIR /app
+
+COPY --chown=gradle:gradle build.gradle.kts settings.gradle.kts gradle.properties gradlew /app/
+COPY --chown=gradle:gradle gradle/ /app/gradle/
+
+RUN chmod +x ./gradlew
+RUN ./gradlew --no-daemon dependencies
+COPY --chown=gradle:gradle src/ /app/src/
+RUN ./gradlew build --no-daemon
+
+FROM eclipse-temurin:21-jre-alpine
+
+RUN addgroup -S app && adduser -S app -G app
+
+WORKDIR /app
+
+RUN chown root:app /app && chmod 2775 /app
+
+COPY --from=build --chmod=644 /app/build/libs/*.jar /app/app.jar
+
+EXPOSE 11434 1234
+
+USER app
+
+ENTRYPOINT ["java", "-jar", "/app/app.jar"]

README.md

@@ -26,8 +26,59 @@ Streaming chat completion API only.
 
 ## How to use
 
-This application is a proxy server, distributed as a fat runnable jar and a GraalVM native image (Windows x64).
+This application is a proxy server, and can be started in a few different ways depending on your workflow.
 
+### Workflows
+
+#### By source code
+
+```sh
+# if you prefer running auto-downloading the required gradle version seamlessly (recommended)
+./gradlew run
+```
+
+```sh
+# if you already have the required project gradle version installed
+gradle run
+```
+
+#### By fat runnable jar
+
+```sh
+# you can compile the app from the source code or download one of the github releases
+# if you compile it, the fat jar will be located at <repo-root>/build/libs
+java -jar ProxyAsLocalModel-0.0.7-all.jar 
+```
+
+#### By native GraalVM image
+
+```sh
+# you can get download the executable from one of the github releases
+# either launch it through a shell or just double click it from the windows explorer
+./proxy.exe
+```
+
+#### By docker compose
+
+```sh
+# if you want to run it on the background
+docker compose up -d --build
+
+# if you want to run it on the foreground
+docker compose up --build
+```
+
+With docker compose, you can bind the config file from your local filesystem so that the config auto-reload works
+Replace the ./config.yml for your config.yml path
+
+```yaml
+    volumes:
+      - './config.yml:/app/config.yml:ro'
+```
+
+You will need to create a placeholder config.yml to start the app, check the next section for reference
+
+### Start
 Run the application, and you will see a help message:
 
 ```

build.gradle.kts

@@ -57,3 +57,8 @@ graalvmNative {
     }
 }
 
+tasks.named<Jar>("jar") {
+    // only the fat “-all.jar” is needed, so we disable the plain jar
+    // this also helps to copy the jar file in docker without knowing its filename
+    enabled = false
+}

compose.yml

@@ -0,0 +1,16 @@
+services:
+  proxy-as-local-model:
+    container_name: proxy-as-local-model
+    build:
+      context: .
+    volumes:
+      - './config.yml:/app/config.yml:ro'
+    ports:
+      - '127.0.0.1:11434:11434'
+      - '127.0.0.1:1234:1234'
+    healthcheck:
+      test: ["CMD", "sh", "-c", "nc -z localhost 11434 || nc -z localhost 1234 || exit 1"]
+      interval: 5s
+      timeout: 10s
+      retries: 3
+    restart: unless-stopped