aurora  by aurora-develop

Web UI for GPT 3.5 access via API

created 1 year ago
2,235 stars

Top 20.7% on sourcepulse

GitHubView on GitHub
Project Summary

Aurora provides a free, web-based interface and API endpoint for GPT-3.5, enabling users to access and interact with the model. It is designed for individuals and developers looking for an accessible way to leverage GPT-3.5 capabilities, potentially bypassing regional restrictions.

How It Works

Aurora acts as a proxy, forwarding requests to OpenAI's GPT-3.5 API. It offers a web UI for direct interaction and an API endpoint compatible with the OpenAI API format. This approach allows users to utilize GPT-3.5 through a self-hosted instance, offering flexibility in configuration and potentially circumventing access limitations by specifying custom base URLs or proxy servers.

Quick Start & Requirements

  • Installation:
    • Binary: git clone https://github.com/aurora-develop/aurora && cd aurora && go build -o aurora && chmod +x ./aurora && ./aurora
    • Docker: docker run -d --name aurora -p 8080:8080 ghcr.io/aurora-develop/aurora:latest
    • Docker Compose: Download docker-compose.yml and run docker-compose up -d.
  • Prerequisites: Go compiler (for binary build), Docker/Docker Compose (for containerized deployment).
  • Configuration: Environment variables can be set for BASE_URL, Authorization (user key), TLS_CERT, TLS_KEY, and PROXY_URL.

Highlighted Details

  • Provides a web UI accessible at http://your_server_ip:8080/web.
  • Offers an API endpoint at http://your_server_ip:8080/v1/chat/completions compatible with OpenAI's format.
  • Supports custom BASE_URL to bypass regional restrictions or use alternative endpoints.
  • Allows configuration of proxy servers and TLS certificates.

Maintenance & Community

The project acknowledges contributions via pull requests. Further community or roadmap information is not detailed in the README.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: The MIT license generally permits commercial use and linking with closed-source projects.

Limitations & Caveats

The project's primary function relies on external GPT-3.5 access, which may be subject to OpenAI's terms of service and availability. The README mentions potential IP-based restrictions that can be bypassed with custom configurations.

Health Check
Last commit

9 months ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
13 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.