Merge pull request #19 from spikeninja/dev

feat: update documentation

Author: spikeninja

README.md

@@ -6,6 +6,7 @@ Standalone admin panel with all data stored in SQLite database
 - [Broker-agnostic admin panel for Taskiq](#broker-agnostic-admin-panel-for-taskiq)
   - [Previews](#previews)
   - [Usage](#usage)
+  - [Docker Compose Examples](#docker-compose-examples)
   - [Development](#development)
 
 ### Previews
@@ -19,13 +20,14 @@ Tasks Page | Task Details Page
 
 ```python
 from typing import Any
+from urllib.parse import urljoin
 from datetime import datetime, UTC
 
 import httpx
 from taskiq import TaskiqMiddleware, TaskiqResult, TaskiqMessage
 
-TASKIQ_ADMIN_URL = "..." # or your env vars from .env
-TASKIQ_ADMIN_API_TOKEN = "..." # or your env vars from .env
+TASKIQ_ADMIN_URL = "..." # or os.getenv() to use .env vars
+TASKIQ_ADMIN_API_TOKEN = "..." # or os.getenv() to use .env vars
 
 
 class TaskiqAdminMiddleware(TaskiqMiddleware):
@@ -35,7 +37,7 @@ class TaskiqAdminMiddleware(TaskiqMiddleware):
         async with httpx.AsyncClient() as client:
             await client.post(
                 headers={"access-token": TASKIQ_ADMIN_API_TOKEN},
-                url=f"{TASKIQ_ADMIN_URL}/tasks/{message.task_id}/started",
+                url=urljoin(TASKIQ_ADMIN_URL, "/api/tasks/{message.task_id}/started"),
                 json={
                     "worker": "WIP",
                     "args": message.args,
@@ -59,7 +61,7 @@ class TaskiqAdminMiddleware(TaskiqMiddleware):
         async with httpx.AsyncClient() as client:
             await client.post(
                 headers={"access-token": TASKIQ_ADMIN_API_TOKEN},
-                url=f"{TASKIQ_ADMIN_URL}/tasks/{message.task_id}/executed",
+                url=urljoin(TASKIQ_ADMIN_URL, "/api/tasks/{message.task_id}/executed"),
                 json={
                     "error": result.error
                     if result.error is None
@@ -78,7 +80,7 @@ class TaskiqAdminMiddleware(TaskiqMiddleware):
 
 2) Pull the image from DockerHub: `docker pull artur10/taskiq-admin:latest`
 
-3) Replace `ACCESS_TOKEN` with any secret enough string and run:
+3) Replace `TASKIQ_ADMIN_API_TOKEN` with any secret enough string and run:
 ```bash
 docker run -d --rm \
   -p "3000:3000" \
@@ -90,6 +92,43 @@ docker run -d --rm \
 
 4) Go to `http://localhost:3000/tasks`
 
+### Docker Compose Examples
+
+.env file example:
+```bash
+...
+TASKIQ_ADMIN_URL=http://taskiq_admin:3000
+TASKIQ_ADMIN_API_TOKEN=supersecret
+...
+```
+
+compose.yml file example
+```shell
+...
+  queue:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    container_name: my_queue
+    command: taskiq worker app.tasks.queue:broker --workers 1 --max-async-tasks 20
+    env_file:
+      - .env
+    depends_on:
+      - redis
+      - taskiq_admin
+
+  taskiq_admin:
+    image: artur10/taskiq-admin:latest
+    container_name: taskiq_admin
+    ports:
+      - 3000:3000
+    env_file:
+      - .env
+    volumes:
+      - ./any/suitable/path:/usr/database/
+...
+```
+
 ### Development
 1) Run `pnpm install` to install all dependencies
 2) Run `pnpm db:push` to create the sqlite database if needed