Skip to content
Toggle navigation
P
Projects
G
Groups
S
Snippets
Help
phsl
/
new-api
This project
Loading...
Sign in
Toggle navigation
Go to a project
Project
Repository
Issues
0
Merge Requests
0
Pipelines
Wiki
Snippets
Members
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Commit
445d6126
authored
Oct 01, 2023
by
JustSong
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: update readme
parent
f4cbce32
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
4 deletions
+11
-4
README.md
+11
-4
No files found.
README.md
View file @
445d6126
...
...
@@ -106,11 +106,17 @@ _✨ 通过标准的 OpenAI API 格式访问所有的大模型,开箱即用
## 部署
### 基于 Docker 进行部署
部署命令:
`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`
```
shell
# 使用 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 的部署命令,在上面的基础上添加 `-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi"`,请自行修改数据库连接参数,不清楚如何修改请参见下面环境变量一节。
# 例如:
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
```
其中,
`-p 3000:3000`
中的第一个
`3000`
是宿主机的端口,可以根据需要进行修改。
数据将会保存在宿主机的
`/home/ubuntu/data/one-api`
目录,请确保该目录存在且具有写入权限,或者更改为合适的目录。
数据
和日志
将会保存在宿主机的
`/home/ubuntu/data/one-api`
目录,请确保该目录存在且具有写入权限,或者更改为合适的目录。
如果启动失败,请添加
`--privileged=true`
,具体参考 https://github.com/songquanpeng/one-api/issues/482 。
...
...
@@ -292,10 +298,11 @@ OPENAI_API_BASE="https://<HOST>:<PORT>/v1"
```
mermaid
graph LR
A(用户)
A --->|请求| B(One API)
A --->|
使用 One API 分发的 key 进行
请求| B(One API)
B -->|中继请求| C(OpenAI)
B -->|中继请求| D(Azure)
B -->|中继请求| E(其他下游渠道)
B -->|中继请求| E(其他 OpenAI API 格式下游渠道)
B -->|中继并修改请求体和返回体| F(非 OpenAI API 格式下游渠道)
```
可以通过在令牌后面添加渠道 ID 的方式指定使用哪一个渠道处理本次请求,例如:
`Authorization: Bearer ONE_API_KEY-CHANNEL_ID`
。
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment