One API 部署与配置指南

news/2024/9/19 12:18:56 标签: openai, oneapi

技术文档：One API 部署与配置指南

概述

One API 是一个多功能的 API 管理平台，支持自定义设置、用户管理、多种登录注册方式、主题切换等。本文档提供了详细的部署和配置指南，帮助用户快速搭建和使用 One API。

部署

基于 Docker 部署

Docker 是一种流行的容器化技术，可以简化部署过程。以下是使用 Docker 部署 One API 的步骤：

拉取镜像：
```
docker pull justsong/one-api
```

运行容器：

使用 SQLite：

docker run --name one-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api

使用 MySQL：

docker run --name one-api -d --restart always -p 3000:3000 -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api

配置 Nginx：
Nginx 可以作为反向代理服务器，提高性能和安全性。以下是一个基本的 Nginx 配置示例：

server {
    server_name openai.justsong.cn;
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $remote_addr;
    }
}

启用 HTTPS：
使用 Let’s Encrypt 提供的 certbot 工具，可以自动化地获取和配置 SSL 证书。
```
sudo certbot --nginx
```

基于 Docker Compose 部署

Docker Compose 允许用户通过 YAML 文件定义多个容器的应用。以下是一个基本的 docker-compose.yml 文件示例：

version: '3'
services:
  one-api:
    image: justsong/one-api
    ports:
      - "3000:3000"
    volumes:
      - ./data:/data
    environment:
      - TZ=Asia/Shanghai

配置

环境变量

环境变量提供了一种灵活的配置方式，以下是一些常用的环境变量：

REDIS_CONN_STRING：连接 Redis 缓存。
SESSION_SECRET：设置会话密钥。
SQL_DSN：数据库连接字符串。
THEME：设置主题。

命令行参数

除了环境变量，One API 还支持通过命令行参数进行配置：

--port：设置监听端口。
--log-dir：设置日志目录。

使用方法

添加 API Key

在 One API 的管理界面中添加您的 API Key，以便在应用程序中使用。

生成访问令牌

在令牌页面生成访问令牌，用于 API 调用的身份验证。

API 调用

使用生成的令牌调用 One API，调用方式与 OpenAI API 一致。

常见问题

数据库连接问题

如果遇到数据库连接问题，确保 SQL_DSN 环境变量正确配置，并且数据库服务运行正常。

部署问题

如果部署后访问出现空白页面，检查 Nginx 配置和容器日志，确保服务正常运行。