技術(shù)文檔：One API 部署與配置指南

概述

One API 是一個(gè)多功能的 API 管理平臺(tái)，支持自定義設(shè)置、用戶管理、多種登錄注冊(cè)方式、主題切換等。本文檔提供了詳細(xì)的部署和配置指南，幫助用戶快速搭建和使用 One API。

部署

基于 Docker 部署

Docker 是一種流行的容器化技術(shù)，可以簡(jiǎn)化部署過(guò)程。以下是使用 Docker 部署 One API 的步驟：

1. 拉取鏡像：

   docker pull justsong/one-api
   

2. 運(yùn)行容器：

   • 使用 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
     

3. 配置 Nginx：
   Nginx 可以作為反向代理服務(wù)器，提高性能和安全性。以下是一個(gè)基本的 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;}
   }
   

4. 啟用 HTTPS：
   使用 Let’s Encrypt 提供的 certbot 工具，可以自動(dòng)化地獲取和配置 SSL 證書(shū)。

   sudo certbot --nginx
   

基于 Docker Compose 部署

Docker Compose 允許用戶通過(guò) YAML 文件定義多個(gè)容器的應(yīng)用。以下是一個(gè)基本的 docker-compose.yml 文件示例：

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

配置

環(huán)境變量

環(huán)境變量提供了一種靈活的配置方式，以下是一些常用的環(huán)境變量：

• REDIS_CONN_STRING：連接 Redis 緩存。
• SESSION_SECRET：設(shè)置會(huì)話密鑰。
• SQL_DSN：數(shù)據(jù)庫(kù)連接字符串。
• THEME：設(shè)置主題。

命令行參數(shù)

除了環(huán)境變量，One API 還支持通過(guò)命令行參數(shù)進(jìn)行配置：

• --port：設(shè)置監(jiān)聽(tīng)端口。
• --log-dir：設(shè)置日志目錄。

使用方法

添加 API Key

在 One API 的管理界面中添加您的 API Key，以便在應(yīng)用程序中使用。

生成訪問(wèn)令牌

在令牌頁(yè)面生成訪問(wèn)令牌，用于 API 調(diào)用的身份驗(yàn)證。

API 調(diào)用

使用生成的令牌調(diào)用 One API，調(diào)用方式與 OpenAI API 一致。

常見(jiàn)問(wèn)題

數(shù)據(jù)庫(kù)連接問(wèn)題

如果遇到數(shù)據(jù)庫(kù)連接問(wèn)題，確保 SQL_DSN 環(huán)境變量正確配置，并且數(shù)據(jù)庫(kù)服務(wù)運(yùn)行正常。

部署問(wèn)題

如果部署后訪問(wèn)出現(xiàn)空白頁(yè)面，檢查 Nginx 配置和容器日志，確保服務(wù)正常運(yùn)行。

相關(guān)項(xiàng)目

• FastGPT：基于 LLM 的知識(shí)庫(kù)問(wèn)答系統(tǒng)。
• ChatGPT Next Web：跨平臺(tái)的 ChatGPT 應(yīng)用。

---

以上是對(duì)原始文檔的補(bǔ)充和擴(kuò)展，增加了關(guān)聯(lián)知識(shí)點(diǎn)和更詳細(xì)的配置說(shuō)明，以幫助用戶更好地理解和使用 One API。