added workflow; updated readme

Author: valaises

.github/workflows/build-and-publish-docker-image-on-tag.yaml

@@ -0,0 +1,45 @@
+name: Build and Publish Docker Image on Tag
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: oasis4691/llm-portal
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=ref,event=branch
+            type=sha
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

README.md

@@ -12,25 +12,38 @@ A FastAPI-based proxy server for Large Language Models (LLMs) that provides a un
 - 🖥️ CLI-based admin interface for user management and stats
 
 
-## Installation, containerized
-1. Clone the repository
+## Installation
+
+Download docker-compose.yaml
 ```bash
-git clone https://github.com/valaises/llm-proxy.git
+wget -O docker-compose.yaml https://raw.githubusercontent.com/valaises/llm-portal/refs/heads/main/docker-compose.yaml
 ```
 
-use docker compose
+Start docker compose
 #### Using Docker Compose
 ```bash
 docker compose up -d
 ```
 
-## Make a Chat Request
+## Installation, Development
+
+Clone repository
+```sh
+git clone https://github.com/valaises/llm-portal.git
+```
+
+Start docker compose
+```sh
+docker compose -f docker-compose-dev.yaml up -d
+```
+
+## Example: Make a Chat Request
 ```bash
-curl http://localhost:7012/v1/chat/completions \
+curl https://llmproxy.xi.valerii.cc/v1/chat/completions \
   -H "Content-Type: application/json" \
-  -H "Authorization: Bearer $LLM_PROXY_API_KEY" \
+  -H "Authorization: Bearer admin1234" \
   -d '{
-    "model": "gpt-4.1",
+    "model": "gemini-2.5-pro",
     "messages": [
       {
         "role": "developer",
@@ -45,21 +58,7 @@ curl http://localhost:7012/v1/chat/completions \
   }'
 ```
 
-
-## Create a User and API KEY
-
-#### Using CLI Admin
-
-(Docker): start interactive terminal
-```bash
-docker exec -it llm_proxy bash
-```
-Start admin CLI
-```bash
-python -m src.core.scripts.cli_admin
-```
-
-#### Using requests
+#### Create a User and API KEY Using requests
 1. Create a user
 ```bash
 ```bash
@@ -87,14 +86,9 @@ You can use DB Viewer to access SQLite DB or use a CLI tool
 
 ### CLI Tool Usage
 
-(Docker): start interactive terminal
-```bash
-docker exec -it llm_proxy bash
-```
-
-Execute CLI tool
+Execute command
 ```bash
-python -m src.core.scripts.show_usage_stats
+docker exec -it llm-portal bash -c "python -m src.core.scripts.show_usage_stats"
 ```
 
 | User ID | Requests | Tokens In | Tokens Out | Cost In ($) | Cost Out ($) | Messages | Models Used       |

docker-compose-example.yaml renamed to docker-compose-dev.yaml

@@ -2,7 +2,7 @@
 services:
   app:
     build: .
-    container_name: "llm_proxy"
+    container_name: "llm-portal"
     environment:
       - LLM_PROXY_SECRET="secret"
       - OPENAI_API_KEY=${OPENAI_API_KEY:-}

docker-compose.yaml

@@ -0,0 +1,22 @@
+services:
+  app:
+    image: oasis4691/llm-portal:latest
+    container_name: "llm-portal"
+    environment:
+      - LLM_PROXY_SECRET="secret"
+      - OPENAI_API_KEY=${OPENAI_API_KEY:-}
+      - GEMINI_API_KEY=${GEMINI_API_KEY:-}
+      - ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY:-}
+      - TOGETHERAI_API_KEY=${TOGETHERAI_API_KEY:-}
+      - OPENROUTER_API_KEY=${OPENROUTER_API_KEY:-}
+
+      - ADMIN_EMAIL=${ADMIN_EMAIL:-admin@default.com}
+      - ADMIN_API_KEY=${ADMIN_API_KEY:-admin1234}
+    ports:
+      - "7012:7012"
+    volumes:
+      - llm-proxy-db:/app/db
+    restart: unless-stopped
+
+volumes:
+  llm-proxy-db: