From a91f1b13488e902d1bd8a0e7fa4a5432fc394d21 Mon Sep 17 00:00:00 2001 From: Rafi Date: Sat, 4 Mar 2023 23:39:49 +0800 Subject: [PATCH] update readme --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21ae04a..8f2d73b 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,17 @@ # ChatGPT UI -A web client for ChatGPT, using OpenAI's API. +A web client for ChatGPT, using OpenAI's API. Provides Docker images and also supports quick deployment to servers using shell scripts. ## πŸ“’Updates
2023-03-04 -**Update to the latest official chat model ** `gpt-3.5-turbo` +**Update to the latest official chat model** `gpt-3.5-turbo` + +**πŸŽ‰πŸŽ‰πŸŽ‰Provide a shell script that can be used to quickly deploy the service to server** [Quick start](#one-click-depolyment) +
@@ -30,6 +33,30 @@ Version 2 introduces the following new features:
+## πŸš€ One-click deployment + +Note: This script has only been tested on Ubuntu Server 22.04 LTS. + +```bash +bash <(curl -Ls https://raw.githubusercontent.com/WongSaang/chatgpt-ui/main/deployment.sh) +``` + +> If you have a domain name, you can point it to the server's IP address using DNS resolution. Of course, using the server's IP address directly is also possible. +> During the script's execution, you will be prompted to enter a domain name. If you do not have a domain name, you can enter the server's IP address directly. + +### After the deployment is complete + +Access `http(s)://your.domain:9000/admin` / IP `http(s)://123.123.123.123:9000/admin` to log in to the administration panel. + +Default superuser: `admin` + +Default password: `password` + +Before you can start chatting, you need to add an OpenAI API key. In the Settings model, add a record with the name `openai_api_key` and the value as your API key. + +Now you can access the web client at `http(s)://your.domain` or `http://123.123.123.123` to start chatting. + +πŸŽ‰πŸŽ‰πŸŽ‰ Enjoy it! ## Quick start with Docker Compose