diff --git a/.env b/.env index cae8618b..78d7cc00 100644 --- a/.env +++ b/.env @@ -1,2 +1,8 @@ OPENAI_API_KEY=placeholder ANTHROPIC_API_KEY=placeholder +YDC_API_KEY=placeholder +TAVILY_API_KEY=placeholder +AZURE_OPENAI_DEPLOYMENT_NAME=placeholder +AZURE_OPENAI_API_KEY=placeholder +AZURE_OPENAI_API_BASE=placeholder +AZURE_OPENAI_API_VERSION=placeholder \ No newline at end of file diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 751349bb..00000000 --- a/Dockerfile +++ /dev/null @@ -1,13 +0,0 @@ -FROM python:3.11 - -RUN apt-get install -y libmagic1 - -WORKDIR /backend - -COPY ./backend . - -RUN rm poetry.lock - -RUN pip install . - -CMD exec uvicorn app.server:app --host 0.0.0.0 --port $PORT diff --git a/README.md b/README.md index 2a5b19a1..5bbb4e70 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,42 @@ yarn dev Navigate to [http://localhost:5173/](http://localhost:5173/) and enjoy! +## Installation and Running with Docker + +This project supports a Docker-based setup, streamlining installation and execution. It automatically builds images for the frontend and backend and sets up Redis using docker-compose. + +### Quick Start + +1. **Clone the Repository:** + Obtain the project files by cloning the repository. + ``` + git clone https://github.com/langchain-ai/opengpts.git + cd opengpts + ``` + +2. **Run with Docker Compose:** + In the root directory of the project, execute: + ``` + docker compose up + ``` + This command builds the Docker images for the frontend and backend from their respective Dockerfiles and starts all necessary services, including Redis. + +3. **Access the Application:** + With the services running, access the frontend at [http://localhost:5173](http://localhost:5173), substituting `5173` with the designated port number. + +4. **Rebuilding After Changes:** + If you make changes to either the frontend or backend, rebuild the Docker images to reflect these changes. Run: + ``` + docker-compose up --build + ``` + This command rebuilds the images with your latest changes and restarts the services. + +### Note +- Ensure Docker and docker-compose are installed on your system. +- Adjust the `.env` file as required for specific environment configurations. + +--- + ## Features As much as possible, we are striving for feature parity with OpenAI. diff --git a/backend/Dockerfile b/backend/Dockerfile new file mode 100644 index 00000000..d8f5ddbe --- /dev/null +++ b/backend/Dockerfile @@ -0,0 +1,16 @@ +# Backend Dockerfile +FROM python:3.11 + +# Install system dependencies +RUN apt-get update && apt-get install -y libmagic1 && rm -rf /var/lib/apt/lists/* + +# Set the working directory +WORKDIR /backend + +COPY ./backend . + +RUN rm poetry.lock + +RUN pip install . + +CMD exec uvicorn app.server:app --host 0.0.0.0 --port $PORT diff --git a/backend/poetry.lock b/backend/poetry.lock index 6983ba0b..fd2e2754 100644 --- a/backend/poetry.lock +++ b/backend/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.5.1 and should not be changed by hand. [[package]] name = "agent-executor" @@ -2232,7 +2232,6 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -2240,15 +2239,8 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -2265,7 +2257,6 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -2273,7 +2264,6 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -2673,7 +2663,7 @@ files = [ ] [package.dependencies] -greenlet = {version = "!=0.4.17", markers = "platform_machine == \"aarch64\" or platform_machine == \"ppc64le\" or platform_machine == \"x86_64\" or platform_machine == \"amd64\" or platform_machine == \"AMD64\" or platform_machine == \"win32\" or platform_machine == \"WIN32\""} +greenlet = {version = "!=0.4.17", markers = "platform_machine == \"win32\" or platform_machine == \"WIN32\" or platform_machine == \"AMD64\" or platform_machine == \"amd64\" or platform_machine == \"x86_64\" or platform_machine == \"ppc64le\" or platform_machine == \"aarch64\""} typing-extensions = ">=4.2.0" [package.extras] @@ -3372,4 +3362,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.8.1" -content-hash = "0fb23784c0634e2721c01fdd3ca1c07bf6805531b8678bd51406f591b9c58f1f" +content-hash = "8e1ffd00427410e2ed3a8026fcfd330d00bce101f0170c6ef69709a2c488e5eb" diff --git a/backend/pyproject.toml b/backend/pyproject.toml index f51f483f..e945421d 100644 --- a/backend/pyproject.toml +++ b/backend/pyproject.toml @@ -25,6 +25,7 @@ tiktoken = "^0.5.1" langchain = ">=0.0.338" permchain = ">=0.0.8" pydantic = "<2.0" +python-magic = "^0.4.27" [tool.poetry.group.dev.dependencies] uvicorn = "^0.23.2" diff --git a/docker-compose.yml b/docker-compose.yml index 7555cd21..d3307c13 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,23 +2,31 @@ version: '3' services: redis: - image: redislabs/redisearch:latest container_name: redis - # Export the port that the service is listening on. - expose: - - "6379" + image: redislabs/redisearch:latest ports: - "6379:6379" + volumes: + - ./redis-volume:/data backend: build: - context: . # Use the current directory as the build context - dockerfile: Dockerfile # Specify the custom Dockerfile + context: . + dockerfile: backend/Dockerfile ports: - - "8100:8100" + - "8100:8100" # Backend is accessible on localhost:8100 depends_on: - redis env_file: - - .env # Use the .env file to load environment variables + - .env environment: PORT: 8100 REDIS_URL: "redis://redis:6379" + + frontend: + build: + context: . + dockerfile: frontend/Dockerfile + ports: + - "5173:5173" # Frontend is accessible on localhost:5173 + environment: + VITE_BACKEND_URL: "http://backend:8100" diff --git a/frontend/Dockerfile b/frontend/Dockerfile new file mode 100644 index 00000000..4aeebd3c --- /dev/null +++ b/frontend/Dockerfile @@ -0,0 +1,21 @@ +# Frontend Dockerfile +FROM node:16 + +# Set the working directory +WORKDIR /frontend + +# Copy the package.json and yarn.lock +COPY ./frontend/package.json ./ +COPY ./frontend/yarn.lock ./ + +# Install Yarn and dependencies +RUN yarn install + +# Copy the rest of the frontend code +COPY ./frontend . + +# Expose the port the frontend runs on +EXPOSE 5173 + +# Command to start the frontend +CMD ["yarn", "dev"] diff --git a/frontend/package.json b/frontend/package.json index 7601c951..ce1073e1 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -4,7 +4,7 @@ "version": "0.0.0", "type": "module", "scripts": { - "dev": "vite", + "dev": "vite --host", "build": "tsc && vite build", "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0", "preview": "vite preview" diff --git a/frontend/vite.config.ts b/frontend/vite.config.ts index 9702f992..20205019 100644 --- a/frontend/vite.config.ts +++ b/frontend/vite.config.ts @@ -7,7 +7,7 @@ export default defineConfig({ server: { proxy: { "^/(assistants|threads|ingest|runs)": { - target: "http://127.0.0.1:8100", + target: process.env.VITE_BACKEND_URL || "http://127.0.0.1:8100", changeOrigin: true, rewrite: (path) => path.replace("/____LANGSERVE_BASE_URL", ""), },