Skip to content

Commit a0ee37e

Browse files
author
AiQL.com
authored
Update README.md
1 parent e355075 commit a0ee37e

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ The `openai-proxy-docker` provides an OpenAI API proxy server image by [Docker](
55

66
## Demo
77

8-
http://api.aiql.com
8+
- #### API demo http://api.aiql.com
9+
- #### UI demo [ChatUI Lite](https://github.com/aiql-community/chat-ui-lite)
910

10-
## UI Demo
11+
### For detailed usage of OpenAI API, please check:
12+
- #### [OpenAI API Reference](https://platform.openai.com/docs/api-reference/introduction) (official docs)
13+
- #### [RESTful OpenAPI](https://api-ui.aiql.com) (provided by AIQL)
1114

12-
[ChatUI Lite](https://github.com/aiql-community/chat-ui-lite)
1315

1416
## How to use
1517
Just:
@@ -24,8 +26,6 @@ Then, you can use it by ```YOURIP:9017```
2426
>
2527
> It should be the same as ```api.openai.com/v1/chat/completions```
2628
27-
For detailed usage of OpenAI API, please check: [OpenAI API Reference](https://platform.openai.com/docs/api-reference/introduction) or [RESTful OpenAPI](https://petstore.swagger.io/?url=https://cdn.jsdelivr.net/gh/openai/openai-openapi@master/openapi.yaml)
28-
2929
You can change default port and default target by setting `-e` in docker, which means that you can use it for any backend followed by OpenAPI format:
3030
| Parameter | Default Value |
3131
| ----- | ----- |
@@ -65,6 +65,20 @@ If everything is OK, check the docker by:
6565
docker build .
6666
```
6767
68+
## Docker Push
69+
70+
If you want to maintaine your own docker image, refer to github [Actions](./.github/workflows/docker-image.yml)
71+
72+
Fork this repo and set `DOCKERHUB_USERNAME` and `DOCKERHUB_TOKEN` in your secrets
73+
74+
Normally, the step should be:
75+
76+
1. [Fork](https://github.com/aiql-community/openai-proxy-docker/fork)
77+
2. Settings
78+
3. Secrets and variables
79+
4. Actions
80+
5. New repository secret
81+
6882
## Docker Compose
6983
7084
This is an example if you want to use this for your own domain with HTTPS:
@@ -73,8 +87,6 @@ This is an example if you want to use this for your own domain with HTTPS:
7387
> e.g.: the proxied OpenAI Chat Completion API will be: `api.example.com/v1/chat/completions`
7488
7589
```DOCKERFILE
76-
version: '3.5'
77-
7890
services:
7991
nginx-proxy:
8092
image: nginxproxy/nginx-proxy

0 commit comments

Comments
 (0)