chore: make docker compose work (#707)

Author: iziang

Dockerfile

@@ -1,23 +1,46 @@
+# Build stage for dlptool
 FROM curlimages/curl:8.4.0 AS downloader
+RUN curl -sL http://kubeblocks.oss-cn-hangzhou.aliyuncs.com/dlptool -o /tmp/dlptool
 
-RUN curl -sL http://kubeblocks.oss-cn-hangzhou.aliyuncs.com/dlptool  -o /tmp/dlptool
+# Build stage for dependencies
+FROM python:3.11.1-slim AS builder
 
+# Install system dependencies
+RUN apt update && \
+    apt install --no-install-recommends -y build-essential git curl && \
+    apt clean && \
+    rm -rf /var/lib/apt/lists/*
 
-FROM python:3.11.1-slim
+# Install Poetry
+RUN curl -sSL https://install.python-poetry.org | python3 - && \
+    cd /usr/local/bin && \
+    ln -s /root/.local/bin/poetry && \
+    poetry config virtualenvs.create false
 
-RUN apt update && \
-    apt install --no-install-recommends -y build-essential git
+# Copy poetry files
+COPY pyproject.toml poetry.lock* ./
 
-COPY requirements.txt /requirements.txt
+# Install dependencies
+RUN poetry install --no-interaction --no-ansi --no-root
 
-RUN pip install -r /requirements.txt && pip cache purge
+# Final stage
+FROM python:3.11.1-slim
 
-COPY . /app
+# Install minimal system dependencies
+RUN apt update && \
+    apt install --no-install-recommends -y curl && \
+    apt clean && \
+    rm -rf /var/lib/apt/lists/*
 
+# Copy only necessary files from builder
+COPY --from=builder /usr/local/lib/python3.11/site-packages /usr/local/lib/python3.11/site-packages
+COPY --from=builder /usr/local/bin /usr/local/bin
 COPY --from=downloader /tmp/dlptool /bin/dlptool
-
 RUN chmod +x /bin/dlptool
 
+# Copy application code
+COPY . /app
+
 WORKDIR /app
 
 ENTRYPOINT ["/app/scripts/entrypoint.sh"]

Makefile

@@ -5,22 +5,31 @@ BUILDX_PLATFORM ?= linux/amd64
 BUILDX_ARGS ?= --sbom=false --provenance=false
 REGISTRY ?= registry.cn-hangzhou.aliyuncs.com
 
-init:
-	cp envs/.env.template .env
-	cp envs/.env.frontend.template .env.frontend
-
 .PHONY: version
 version:
 	@git rev-parse HEAD | cut -c1-7 > commit_id.txt
 	@echo "VERSION = '$(VERSION)'" > $(VERSION_FILE)
 	@echo "GIT_COMMIT_ID = '$$(cat commit_id.txt)'" >> $(VERSION_FILE)
 	@rm commit_id.txt
 
-build-requirements:
-	sh scripts/export-requirements.sh
+.PHONY: image
+
+# Create a new builder instance for multi-platform builds
+setup-builder:
+	@if ! docker buildx inspect multi-platform >/dev/null 2>&1; then \
+		docker buildx create --name multi-platform --use --driver docker-container; \
+	else \
+		docker buildx use multi-platform; \
+	fi
+
+# Build and push multi-platform image
+image: setup-builder
+	docker buildx build -t $(REGISTRY)/apecloud/aperag:$(VERSION) --platform $(BUILDX_PLATFORM) $(BUILDX_ARGS) --push -f ./Dockerfile .
+	cd web && docker buildx build -t $(REGISTRY)/apecloud/aperag-frontend:$(VERSION) --platform $(BUILDX_PLATFORM) $(BUILDX_ARGS) --push -f ./Dockerfile .
 
-image: build-requirements version
-	docker buildx build -t $(REGISTRY)/apecloud/aperag:$(VERSION) --platform $(BUILDX_PLATFORM) $(BUILDX_ARGS) --push -f ./Dockerfile  .
+# Clean up builder instance
+clean-builder:
+	docker buildx rm multi-platform
 
 diff:
 	@python manage.py diffsettings

README.md

@@ -2,6 +2,38 @@
 
 ApeRAG is a powerful RAG system that deeply analyzes documents and multimedia content while building vector indexes in parallel and measuring retrieval quality. It streamlines workflows with integrated LLM management, data source handling, automatic syncing, and seamless office tool compatibility.
 
+## User Guide
+
+### Prerequisites
+
+- Docker
+- Docker Compose
+- Git
+
+### Quick Start
+
+1. Configure environment variables:
+   ```bash
+   cp envs/docker.env.template .docker.env
+   cp web/deploy/env.local.template web/.env
+   ```
+
+2. (Optional) use aliyun image registry if you are in China:
+   ```bash
+   export REGISTRY=apecloud-registry.cn-zhangjiakou.cr.aliyuncs.com
+   ```
+
+3. Start the services:
+   ```bash
+   docker compose up -d
+   ```
+
+4. Access the services: http://localhost:80
+
+## License
+
+[Your License Here]
+
 # Development Guide
 
 You should install Python 3.11 first.
@@ -24,7 +56,7 @@ poetry install --with model
 * prepare configs
 
 ```bash
-cp envs/.env.template .env
+cp envs/env.template .env
 ```
 
 * prepare postgres/redis/qdrant/elasticsearch
@@ -63,5 +95,4 @@ To debug celery service, see [HOW-TO-DEBUG.md](docs%2FHOW-TO-DEBUG.md)
 make run-frontend
 ```
 
-
 then open the aperag frontend console: http://localhost:8001

docker-compose.yml

@@ -1,76 +1,135 @@
-version: '3'
-
 volumes:
-  aperag_postgres_data: {}
-  aperag_qdrant_data: {}
+  aperag-postgres-data: {}
+  aperag-qdrant-data: {}
+  aperag-redis-data: {}
+  aperag-es-data: {}
 
 services:
   django: &django
     build:
       context: .
       dockerfile: ./Dockerfile
-    image: aperag_django
-    container_name: aperag_django
+    image: ${REGISTRY:-docker.io}/apecloud/aperag:${VERSION:-v0.1.2}
+    container_name: aperag-django
     depends_on:
       - postgres
       - redis
       - qdrant
+      - es
     volumes:
       - .:/app:z
       - ~/.cache:/root/.cache
     env_file:
-      - .docker-env
+      - .docker.env
     ports:
       - "8000:8000"
-    command: /app/scripts/start-django.sh
+    entrypoint: /app/scripts/start-django.sh
 
-  postgres:
-    image: postgres:14
-    container_name: aperag_postgres
-    volumes:
-      - aperag_postgres_data:/var/lib/postgresql/data
+  frontend:
+    build:
+      context: ./web
+      dockerfile: ./Dockerfile
+    image: ${REGISTRY:-docker.io}/apecloud/aperag-frontend:${VERSION:-v0.1.2}
+    container_name: aperag-frontend
+    depends_on:
+      - django
     env_file:
-      - .docker-env
-
-  redis:
-    image: redis:6
-    container_name: aperag_redis
-
-  qdrant:
-    image: qdrant/qdrant
-    container_name: aperag_qdrant
-    volumes:
-      - aperag_qdrant_data:/qdrant/storage
+      - web/.env
+    environment:
+      - APERAG_CONSOLE_SERVICE_HOST=aperag-django
+      - APERAG_CONSOLE_SERVICE_PORT=8000
+    ports:
+      - "8001:80"
 
   celeryworker:
-    <<: *django
-    image: aperag_django
-    container_name: aperag_celeryworker
+    image: ${REGISTRY:-docker.io}/apecloud/aperag:${VERSION:-v0.1.2}
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    container_name: aperag-celeryworker
     depends_on:
       - redis
       - postgres
       - qdrant
+      - es
     volumes:
       - .:/app:z
       - ~/.cache:/root/.cache
       - ./resources:/Users/ziang/git/ApeRAG/resources
-    ports: []
-    command: /app/scripts/start-celery-worker.sh
+    env_file:
+      - .docker.env
+    environment:
+      - NODE_IP=aperag-celeryworker
+    entrypoint: /app/scripts/start-celery-worker.sh
 
   celerybeat:
-    <<: *django
-    image: aperag_django
-    container_name: aperag_celerybeat
+    image: ${REGISTRY:-docker.io}/apecloud/aperag:${VERSION:-v0.1.2}
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    container_name: aperag-celerybeat
+    env_file:
+      - .docker.env
     depends_on:
       - redis
       - postgres
-    ports: []
-    command: /app/scripts/start-celery-beat.sh
+    environment:
+      - NODE_IP=aperag-celerybeat
+    entrypoint: /app/scripts/start-celery-beat.sh
 
   flower:
     <<: *django
-    image: aperag_django
-    container_name: aperag_flower
+    image: ${REGISTRY:-docker.io}/apecloud/aperag:${VERSION:-v0.1.2}
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    container_name: aperag-flower
+    env_file:
+      - .docker.env
     ports:
       - "5555:5555"
-    command: /app/scripts/start-celery-flower.sh
+    environment:
+      - NODE_IP=aperag-flower
+    entrypoint: /app/scripts/start-celery-flower.sh
+
+  postgres:
+    image: postgres:14
+    container_name: aperag-postgres
+    volumes:
+      - aperag-postgres-data:/var/lib/postgresql/data
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_USER=postgres
+      - POSTGRES_DB=aperag
+
+  redis:
+    image: redis:6
+    container_name: aperag-redis
+    volumes:
+      - aperag-redis-data:/data
+    ports:
+      - "6379:6379"
+
+  qdrant:
+    image: qdrant/qdrant:v1.13.4
+    container_name: aperag-qdrant
+    volumes:
+      - aperag-qdrant-data:/qdrant/storage
+    ports:
+      - "6333:6333"
+
+  es:
+    image: elasticsearch:8.8.2
+    container_name: aperag-es
+    ports:
+      - "9200:9200"
+    environment:
+      - "discovery.type=single-node"
+      - "ES_JAVA_OPTS=-Xms1g -Xmx1g"
+      - "xpack.security.enabled=false"
+    volumes:
+      - aperag-es-data:/usr/share/elasticsearch/data
+      - ./scripts/init-es.sh:/usr/share/elasticsearch/bin/init-es.sh
+    command: bash /usr/share/elasticsearch/bin/init-es.sh