This project provides a self-hosted web interface for interacting with OpenAI's ChatGPT API, targeting users who want to deploy their own private ChatGPT instance. It offers a familiar chat interface, supports continuous conversation, and allows for API key customization.

How It Works

The application is built using FastAPI for the backend and Vue.js 3 for the frontend. The backend handles API requests to OpenAI, ensuring that user API keys are not exposed directly in the browser. It supports continuous conversation history and allows for proxy configurations via environment variables.

Quick Start & Requirements

• Docker: docker run --name chatgpt -d -p 8000:8000 -e API_KEY=sk-xxxx miclon/chatgpt:latest
• Prerequisites: Docker, OpenAI API Key. Local deployment requires Node.js (pnpm) and Python 3.
• Setup: Docker deployment is straightforward. Local setup involves installing frontend and backend dependencies.
• Docs: PROXY.md

Highlighted Details

• Supports both gpt-3.5-turbo and other models via API.
• Frontend allows custom API key input, overriding backend configuration.
• Backend separation enhances API key security.
• Includes instructions for modifying copyright information via GitHub Actions and Docker Hub integration.

Maintenance & Community

The project is maintained by mic1on. Further community interaction details are not specified in the README.

Licensing & Compatibility

The project's license is not explicitly stated in the README. Compatibility for commercial use or closed-source linking is not detailed.

Limitations & Caveats

The project relies on an external OpenAI API key, incurring costs. Modifying copyright requires GitHub Actions and Docker Hub setup, which may be complex for some users. The README does not specify the exact license, which could impact commercial use.