Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aiqlcom authored Oct 6, 2024
1 parent d683665 commit 2fce74b
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,42 @@ By simplifying the structure and key functions, developers can quickly set up an

## How to use

### Option 1: Goto demo [AIQL](https://chat.aiql.com/)
#### Option 1: Goto demo [AIQL](https://chat.aiql.com/)
> The demo will use `Qwen 2.5` by default
### Option 2: Download [Index](./index.html) and open it locally (recommended)
#### Option 2: Download [Index](./index.html) and open it locally (recommended)

### Option 3: Deploy your own Chatbot by [Docker](https://hub.docker.com/repository/docker/aiql/chat-ui/tags?page=1&ordering=last_updated)
#### Option 3: Deploy your own Chatbot by [Docker](https://hub.docker.com/repository/docker/aiql/chat-ui/tags?page=1&ordering=last_updated)
```shell
docker run -p 8080:8080 -d aiql/chat-ui
```

### Option 4: fork this repo and link it to [Cloudflare pages](https://developers.cloudflare.com/pages)
#### Option 4: fork this repo and link it to [Cloudflare pages](https://developers.cloudflare.com/pages)
- demo https://www2.aiql.com

## How to config

By default, the Chatbot will use API format as OpenAI Chatgpt. You can insert your OpenAI `API Key` and use it directly.
By default, the Chatbot will use API format as OpenAI ChatGPT.

Or change the `Endpoint` in configuration to use API from other vendors
You can insert your OpenAI `API Key` and change the `Endpoint` in configuration to use API from any other vendors

> You can download the config template from [example](./example/config) and use it for quick configuration
You can also download the config template from [example](./example/config) and insert your `API Key`, then use it for quick configuration

## Trouble Shooting

If you're experiencing issues opening the page and a simple refresh isn't resolving the issue, please take the following steps:

### 1. Right-click your browser page and go to the `Network` section.
### 2. Right-click on section table and clear your browser's cache and cookies to ensure you have the latest version of the page.
### 3. Additionally, inspect the browser's Network section to see which resources are failing to load due to your location. This will provide you with more specific information about the issue.
### Reset Interface Configuration
1. Click `Refresh` icon on the upper right of `Interface Configuration`

### Reset All Configuration
1. Click hidden botton on the right side of the index page
2. Click `Reset All Config` icon

### Reset Cache
1. Right-click your browser page and go to the `Network` section.
2. Right-click on section table and clear your browser's cache and cookies to ensure you have the latest version of the page.
3. Additionally, inspect the browser's Network section to see which resources are failing to load due to your location. This will provide you with more specific information about the issue.


## Demo
Expand Down

0 comments on commit 2fce74b

Please sign in to comment.