Gemini Proxy Panel

本项目遵循CC BY-NC 4.0协议，禁止任何形式的商业倒卖行为。
This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0).
Commercial resale or any form of commercial use is prohibited.

中文介绍

详细部署与使用文档(新手看这里)

Introduction

gemini-proxy-panel is a proxy service. It forwards requests formatted for the OpenAI API to the Google Gemini Pro API, allowing applications developed for OpenAI to seamlessly switch to or leverage the capabilities of Gemini models.

Features

• OpenAI to Gemini Proxy: Seamlessly translates OpenAI Chat API requests into Gemini Pro API requests.
• Multi-API Key Rotation: Supports configuring multiple Gemini API keys and automatically rotates through them to distribute request load and circumvent rate limits.
• Quota and Usage Management: Monitor the usage of each Gemini API key through an intuitive management interface.
• Key Management: Centrally manage multiple Gemini API keys and Worker API keys (used to access this proxy service) within the management panel.
• Model Configuration: Define and manage the Gemini models supported by this proxy in the management panel.
• Intuitive Management Interface: Provides a Web UI (/login or /admin) to view API usage statistics and configure settings.
• One-Click Deployment: Supports quick deployment to the Cloudflare Workers platform via the "Deploy to Cloudflare" button.
• GitHub Actions Automatic Deployment: After forking the repository, enables automatic deployment via GitHub Actions upon code push.
• GitHub Database Sync: Leverages GitHub repositories for automatic database synchronization.

Hugging Face Space Deployment

This deployment method utilizes Hugging Face Space's Docker environment and requires enabling GitHub sync for data persistence.

1. Prepare GitHub Repository and PAT:

   • You need your own GitHub repository to store synchronized data. A private repository is recommended.
   • Create a GitHub Personal Access Token (PAT) with the repo permission scope. Keep this token secure.

2. Create a Hugging Face Space:

   • Visit Hugging Face and create a new Space.
   • Select "Docker" as the Space SDK.
   • Choose "Use existing Dockerfile from repository".

3. Configure Space Secrets:

   • Go to your Space's "Settings" -> "Repository secrets".
   • Add the following Secrets:
     • ADMIN_PASSWORD: Set a login password for the admin panel.
     • SESSION_SECRET_KEY: Set a long, random session key.
     • GITHUB_PROJECT: Enter your own GitHub repository path in the format your-username/your-repo-name.
     • GITHUB_PROJECT_PAT: Enter your GitHub PAT created earlier.
     • GITHUB_ENCRYPT_KEY: Set an encryption key for synced data, must be at least 32 characters long.

4. Create Dockerfile:

   • In your Hugging Face Space's "Files" tab, click "Add file" -> "Create new file".
   • Set the filename to Dockerfile.
   • Paste the following content into the file:

     FROM dreamhartley705/gemini-proxy-panel:huggingface

   • Click "Commit new file".

5. Launch and Access:

   • Hugging Face Space will automatically build and start the application using this Dockerfile.
   • Once launched, the app will connect to your GitHub repository for data syncing using your configured Secrets.
   • You can access the admin panel (/login or /admin) and API (/v1) via the URL provided by the Space.

Local Node.js Deployment

This method is suitable for local development and testing.

1. Clone the Repository:

   git clone https://github.com/dreamhartley/gemini-proxy-panel.git
   cd gemini-proxy-panel

2. Install Dependencies:

   npm install

3. Configure Environment Variables:

   • Copy the .env.example file to .env:

     cp .env.example .env

   • Edit the .env file, setting at minimum:
     • ADMIN_PASSWORD: Set the admin panel login password.
     • SESSION_SECRET_KEY: Set a long, random string for session security (e.g., generate with openssl rand -base64 32).
     • PORT (optional): Default is 3000, change as needed.
   • (Optional) Configure GitHub Sync: To sync data to a GitHub repository, set:
     • GITHUB_PROJECT: Your GitHub repository path in format username/repo-name. Note: This is your own repository for data backup, not this project's repository.
     • GITHUB_PROJECT_PAT: Your GitHub Personal Access Token with repo permission.
     • GITHUB_ENCRYPT_KEY: An encryption key for syncing data, must be at least 32 characters long.

4. Start the Service:

   npm start

   The service will run at http://localhost:3000 (or your configured port).

Docker Deployment

You can quickly deploy using Docker or Docker Compose.

Method 1: Using docker build and docker run

1. Clone the Repository:

   git clone https://github.com/dreamhartley/gemini-proxy-panel.git
   cd gemini-proxy-panel

2. Configure Environment Variables:

   • Copy the .env.example file to .env:

     cp .env.example .env

   • Edit the .env file, setting the necessary variables (ADMIN_PASSWORD, SESSION_SECRET_KEY) and optional GitHub sync variables (GITHUB_PROJECT, GITHUB_PROJECT_PAT, GITHUB_ENCRYPT_KEY). Note: The PORT variable typically doesn't need to be set in the .env file for Docker deployments, as port mapping is done in the docker run command.

3. Build the Docker Image:

   docker build -t gemini-proxy-panel .

4. Run the Docker Container:

   docker run -d --name gemini-proxy-panel \
     -p 3000:3000 \
     --env-file .env \
     -v ./data:/usr/src/app/data \
     gemini-proxy-panel

   • -d: Run the container in the background.
   • --name gemini-proxy-panel: Name for the container.
   • -p 3000:3000: Map host port 3000 to container port 3000.
   • --env-file .env: Load environment variables from the .env file.
   • -v ./data:/usr/src/app/data: Mount the local data directory to the container for SQLite database persistence. Ensure the data directory exists locally.

Method 2: Using docker-compose (Recommended)

1. Clone the Repository:

   git clone https://github.com/dreamhartley/gemini-proxy-panel.git
   cd gemini-proxy-panel

2. Configure Environment Variables:

   • Copy the .env.example file to .env:

     cp .env.example .env

   • Edit the .env file, setting the necessary variables (ADMIN_PASSWORD, SESSION_SECRET_KEY) and optional GitHub sync variables (GITHUB_PROJECT, GITHUB_PROJECT_PAT, GITHUB_ENCRYPT_KEY).

3. Start the Service:

   docker-compose up -d

   Docker Compose will automatically build the image (if needed), create and start the container, and handle port mapping, environment variables, and data volumes according to the docker-compose.yml file.

Usage

Management Panel

1. Access the /login or /admin path of your Worker URL (e.g., https://your-worker-name.your-subdomain.workers.dev/login).
2. Log in using the ADMIN_PASSWORD you set.
3. In the management panel, you can:
   • Add and manage your Gemini API keys.
   • Add and manage API keys used to access this Worker proxy (Worker API Keys).
   • Set global quotas for Pro and Flash series models.
   • View usage statistics for each Gemini API key.
   • Configure supported Gemini models.

API Proxy

1. Point the API endpoint of your application (originally configured to call the OpenAI API) to your deployed Worker URL (e.g., https://your-worker-name.your-subdomain.workers.dev/v1).
2. Ensure that your application includes valid authentication information when sending requests. This is usually done by carrying the "Worker API Key" configured in the management panel in the Authorization request header:

   Authorization: Bearer <your_worker_api_key>
   

3. Send requests compatible with the OpenAI Chat Completions API. The Worker will convert them into Gemini API requests and return the formatted response.

Configuration Overview

Configuration Overview

Local Node.js / Docker / Hugging Face Deployments

These deployment methods configure environment variables through the .env file or Secrets (Hugging Face).

• Core Environment Variables (Required):
  • ADMIN_PASSWORD: Login password for the admin panel.
  • SESSION_SECRET_KEY: Key for securing user sessions (use a long, random string).
• Optional Environment Variables:
  • PORT: (Local Node.js/Docker only) Port for the service to listen on, default is 3000. Hugging Face handles the port automatically.
• GitHub Sync Environment Variables (Optional, Required for Hugging Face):
  • GITHUB_PROJECT: Path to your own GitHub repository for data syncing (format: username/repo-name).
  • GITHUB_PROJECT_PAT: GitHub Personal Access Token with repo permission.
  • GITHUB_ENCRYPT_KEY: Key for encrypting synced data (at least 32 characters).