From 1320d69cfb7efb76fd004312dff053c1ef47d974 Mon Sep 17 00:00:00 2001 From: Rafi Date: Wed, 12 Apr 2023 14:23:32 +0800 Subject: [PATCH] docs: Adjust directory structure --- docs/README.md | 1 + docs/guide/quick-start.md | 10 ++++++---- docs/zh/README.md | 1 + docs/zh/guide/quick-start.md | 10 ++++++---- 4 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/README.md b/docs/README.md index ab8d22c..410a360 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,6 +21,7 @@ This project consists of two parts, the client-side and the server-side: - Web search capability, allowing ChatGPT to retrieve the latest information. - Convenient tools, supporting one-click message and code block copying, as well as message editing. - Common command management, allowing users to store and edit their own common commands. +- PWA, supporting installation to the desktop. ### Server-side - The server-side has an administrative panel. diff --git a/docs/guide/quick-start.md b/docs/guide/quick-start.md index 20fe6af..6d848ca 100644 --- a/docs/guide/quick-start.md +++ b/docs/guide/quick-start.md @@ -4,7 +4,9 @@ This project provides related docker images for deployment on a VPS or your loca You also need an OpenAI API Key, and there are multiple ways to obtain it online, please search for it yourself. -## Quick deployment through script +## Deploying + +### Quickly deploy script **Note: This script has only been verified on Ubuntu Server 22.04 LTS.** @@ -12,10 +14,10 @@ You also need an OpenAI API Key, and there are multiple ways to obtain it online bash <(curl -Ls https://raw.githubusercontent.com/WongSaang/chatgpt-ui/main/deployment.sh) ``` -## Deployment through Docker Compose +### Docker Compose -### Prepare docker-compose.yml +#### Prepare docker-compose.yml The project provides a sample `docker-compose.yml`. If you want to customize the configuration, please refer to the [configuration reference](/en/guide/configuration) section. @@ -84,7 +86,7 @@ networks: driver: bridge ``` -### Starting the Service +#### Starting the Service After modifying the configuration as needed, you can start the service by running the following command: diff --git a/docs/zh/README.md b/docs/zh/README.md index 798f350..695193f 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -20,6 +20,7 @@ ChatGPT UI 是一个非官方的 ChatGPT Web 客户端。它支持多用户， - 网页搜索能力，让 ChatGPT 获取最新信息。 - 便捷的工具，支持一键复制消息和代码块，以及重新编辑消息等。 - 常用指令管理，用户可存储和编辑自己的常用指令。 +- PWA，支持安装到桌面。 ### 服务端 - 服务端拥有一个管理面板 diff --git a/docs/zh/guide/quick-start.md b/docs/zh/guide/quick-start.md index bf6d211..b269e91 100644 --- a/docs/zh/guide/quick-start.md +++ b/docs/zh/guide/quick-start.md @@ -4,7 +4,9 @@ 您还需要一个 OpenAI 的API Key，网上有获取多种方案，请自行搜索。 -## 通过脚本快速部署 +## 部署 + +### 快速部署脚本 *对于技术知识了解不多的选手，如果你看不懂下面的内容，可以看我之前写的博客文章[《一行命令部署自己的ChatGPT客户端》](https://wongsnotes.com/p/deploying-your-own-chatgpt-client-with-one-line-of-command/)* @@ -15,10 +17,10 @@ bash <(curl -Ls https://raw.githubusercontent.com/WongSaang/chatgpt-ui/main/deployment.sh) ``` -## 通过 Docker Compose 部署 +### Docker Compose -### 准备 docker-compose.yml +#### 准备 docker-compose.yml 项目中提供了一个 `docker-compose.yml` 示例，如果你想自定义配置，请看 [配置参考](/zh/guide/configuration) 部分。 @@ -82,7 +84,7 @@ networks: driver: bridge ``` -### 启动服务 +#### 启动服务 你可以自行修改配置后，运行下面的命令来启动服务。