ChatGPT Web

Disclaimer: This project is only published on GitHub, based on the MIT license, free and for open source learning usage. And there will be no any form of account selling, paid service, discussion group, discussion group and other behaviors. Beware of being deceived.

Trung văn

• ChatGPT Web
  • Introduction
  • Roadmap
  • Prerequisites
    • Node
    • PNPM
    • Filling in the Key
  • Install Dependencies
    • Backend
    • Frontend
  • Run in Test Environment
    • Backend Service
    • Frontend Webpage
  • Environment Variables
  • Packaging
    • Use Docker
      • Docker Parameter Examples
      • Docker build & Run
      • Docker compose
      • Prevent Crawlers
    • Deploy with Railway
      • Railway Environment Variables
    • Deploy with Sealos
    • Package Manually
      • Backend Service
      • Frontend Webpage
  • FAQ
  • Contributing
  • Acknowledgements
  • Sponsors
  • License

Introduction

Supports dual models and provides two unofficialChatGPT APImethods

Method	Free?	Reliability	Quality
ChatGPTAPI(gpt-3.5-turbo-0301)	No	Reliable	Relatively stupid
ChatGPTUnofficialProxyAPI(web accessToken)	Yes	Relatively unreliable	Smart

Comparison:

1. ChatGPTAPIusesgpt-3.5-turbothroughOpenAIofficialAPIto callChatGPT
2. ChatGPTUnofficialProxyAPIuses unofficial proxy server to accessChatGPT's backendAPI,bypassCloudflare(dependent on third-party servers, and has rate limits)

Warnings:

1. You should first use theAPImethod
2. When using theAPI,if the network is not working, it is blocked in China, you need to build your own proxy, never use someone else's public proxy, which is dangerous.
3. When using theaccessTokenmethod, the reverse proxy will expose your access token to third parties. This should not have any adverse effects, but please consider the risks before using this method.
4. When usingaccessToken,whether you are a domestic or foreign machine, proxies will be used. The default proxy ispengzhile'shttps://ai.fakeopen.com/api/conversation.This is not a backdoor or monitoring unless you have the ability to flip overCFverification yourself. Use beforehand acknowledge.Community Proxy(Note: Only these two are recommended, other third-party sources, please identify for yourself)
5. When publishing the project to public network, you should set theAUTH_SECRET_KEYvariable to add your password access, you should also modify thetitleinindex. htmlto prevent it from being searched by keywords.

Switching methods:

1. Enter theservice/.env.examplefile, copy the contents to theservice/.envfile
2. To useOpenAI API Key,fill in theOPENAI_API_KEYfield(get apiKey)
3. To useWeb API,fill in theOPENAI_ACCESS_TOKENfield(get accessToken)
4. OpenAI API Keytakes precedence when both exist

Environment variables:

See all parameter variableshere

Roadmap

[✓] Dual models

[✓] Multi-session storage and context logic

[✓] Formatting and beautification of code and other message types

[✓] Access control

[✓] Data import/export

[✓] Save messages as local images

[✓] Multilingual interface

[✓] Interface themes

[✗] More...

Prerequisites

Node

noderequires version^16 || ^18 || ^19(node >= 14needsfetch polyfillinstallation), usenvmto manage multiple localnodeversions

node -v

PNPM

If you haven't installedpnpm

npm install pnpm -g

Filling in the Key

GetOpenai Api KeyoraccessTokenand fill in the local environment variablesGo to Introduction

# service/.env file

# OpenAI API Key - https://platform.openai.com/overview
OPENAI_API_KEY=

# change this to an `accessToken` extracted from the ChatGPT site's `https://chat.openai.com/api/auth/session` response
OPENAI_ACCESS_TOKEN=

Install Dependencies

For the convenience of "backend developers" to understand the burden, the front-end "workspace" mode is not adopted, but separate folders are used to store them. If you only need to do secondary development of the front-end page, delete theservicefolder.

Backend

Enter the folder/serviceand run the following commands

pnpm install

Frontend

Run the following commands at the root directory

pnpm bootstrap

Run in Test Environment

Backend Service

Enter the folder/serviceand run the following commands

pnpm start

Frontend Webpage

Run the following commands at the root directory

pnpm dev

Environment Variables

APIavailable:

• OPENAI_API_KEYandOPENAI_ACCESS_TOKENchoose one
• OPENAI_API_MODELSet model, optional, default:gpt-3.5-turbo
• OPENAI_API_BASE_URLSet interface address, optional, default:https://api.openai.com
• OPENAI_API_DISABLE_DEBUGSet interface to close debug logs, optional, default: empty does not close

ACCESS_TOKENavailable:

• OPENAI_ACCESS_TOKENandOPENAI_API_KEYchoose one,OPENAI_API_KEYtakes precedence when both exist
• API_REVERSE_PROXYSet reverse proxy, optional, default:https://ai.fakeopen.com/api/conversation,Community(Note: Only these two are recommended, other third party sources, please identify for yourself)

Common:

• AUTH_SECRET_KEYAccess permission key, optional
• MAX_REQUEST_PER_HOURMaximum number of requests per hour, optional, unlimited by default
• TIMEOUT_MSTimeout, unit milliseconds, optional
• SOCKS_PROXY_HOSTandSOCKS_PROXY_PORTtake effect together, optional
• SOCKS_PROXY_PORTandSOCKS_PROXY_HOSTtake effect together, optional
• HTTPS_PROXYSupporthttp,https,socks5,optional
• ALL_PROXYSupporthttp,https,socks5,optional

Packaging

Use Docker

Docker Parameter Examples

Docker build & Run

docker build -t chatgpt-web.

#Foreground running
docker run --name chatgpt-web --rm -it -p 127.0.0.1:3002:3002 --env OPENAI_API_KEY=your_api_key chatgpt-web

#Background running
docker run --name chatgpt-web -d -p 127.0.0.1:3002:3002 --env OPENAI_API_KEY=your_api_key chatgpt-web

#Run address
http://localhost:3002/

Docker compose

Hub address

version:'3'

services:
app:
image:chenzhaoyu94/chatgpt-web#always use latest, pull the tag image again to update
ports:
-127.0.0.1:3002:3002
environment:
#choose one
OPENAI_API_KEY:sk-xxx
#choose one
OPENAI_ACCESS_TOKEN:xxx
#API interface address, optional, available when OPENAI_API_KEY is set
OPENAI_API_BASE_URL:xxx
#API model, optional, available when OPENAI_API_KEY is set, https://platform.openai.com/docs/models
#gpt-4, gpt-4o, gpt-4o-mini, gpt-4-turbo, gpt-4-turbo-preview, gpt-4-0125-preview, gpt-4-1106-preview, gpt-4-0314, gpt-4-0613, gpt-4-32k, gpt-4-32k-0314, gpt-4-32k-0613, gpt-3.5-turbo-16k, gpt-3.5-turbo-16k-0613, gpt-3.5-turbo, gpt-3.5-turbo-0301, gpt-3.5-turbo-0613, text-davinci-003, text-davinci-002, code-davinci-002
OPENAI_API_MODEL:xxx
#reverse proxy, optional
API_REVERSE_PROXY:xxx
#access permission key, optional
AUTH_SECRET_KEY:xxx
#maximum number of requests per hour, optional, unlimited by default
MAX_REQUEST_PER_HOUR:0
#timeout, unit milliseconds, optional
TIMEOUT_MS:60000
#Socks proxy, optional, take effect with SOCKS_PROXY_PORT
SOCKS_PROXY_HOST:xxx
#Socks proxy port, optional, take effect with SOCKS_PROXY_HOST
SOCKS_PROXY_PORT:xxx
#HTTPS proxy, optional, support http,https,socks5
HTTPS_PROXY:http://xxx:7890

• OPENAI_API_BASE_URLOptional, available whenOPENAI_API_KEYis set
• OPENAI_API_MODELOptional, available whenOPENAI_API_KEYis set

Prevent Crawlers

nginx

Fill in the following configuration in the nginx configuration file to prevent crawlers. You can refer to thedocker-compose/nginx/nginx.conffile to add anti-crawler methods

# Prevent crawlers
if ($http_user_agent ~* "360Spider|JikeSpider|Spider|spider|bot|Bot|2345Explorer|curl|wget|webZIP|qihoobot|Baiduspider|Googlebot|Googlebot-Mobile|Googlebot-Image|Mediapartners-Google|Adsbot-Google|Feedfetcher-Google|Yahoo! Slurp|Yahoo! Slurp China|YoudaoBot|Sosospider|Sogou spider|Sogou web spider|MSNBot|ia_archiver|Tomato Bot|NSPlayer|bingbot" )
{
return 403;
}

Deploy with Railway

Railway Environment Variables

Environment variable name	Required	Remarks
PORT	Required	Default3002
AUTH_SECRET_KEY	Optional	Access permission key
MAX_REQUEST_PER_HOUR	Optional	Maximum number of requests per hour, optional, unlimited by default
TIMEOUT_MS	Optional	Timeout, unit milliseconds
OPENAI_API_KEY	OpenAI APIchoose one	apiKeyrequired forOpenAI API(get apiKey)
OPENAI_ACCESS_TOKEN	Web APIchoose one	accessTokenrequired forWeb API(get accessToken)
OPENAI_API_BASE_URL	Optional, available whenOpenAI API	APIinterface address
OPENAI_API_MODEL	Optional, available whenOpenAI API	APImodel
API_REVERSE_PROXY	Optional, available whenWeb API	Web APIreverse proxy addressDetails
SOCKS_PROXY_HOST	Optional, take effect withSOCKS_PROXY_PORT	Socks proxy
SOCKS_PROXY_PORT	Optional, take effect withSOCKS_PROXY_HOST	Socks proxy port
SOCKS_PROXY_USERNAME	Optional, take effect withSOCKS_PROXY_HOST	Socks proxy username
SOCKS_PROXY_PASSWORD	Optional, take effect withSOCKS_PROXY_HOST	Socks proxy password
HTTPS_PROXY	Optional	HTTPS proxy, support http,https, socks5
ALL_PROXY	Optional	All proxies, support http,https, socks5

Note: Modifying environment variables onRailwaywill re-Deploy

Deploy with Sealos

Environment variables are consistent with Docker environment variables

Package Manually

Backend Service

If you don't need thenodeinterface of this project, you can omit the following operations

Copy theservicefolder to the server where you have thenodeservice environment.

#Install
pnpm install

#Pack
pnpm build

#Run
pnpm prod

PS: It is also okay to runpnpm startdirectly on the server without packing

Frontend Webpage

1. Modify theVITE_GLOB_API_URLfield in the.envfile at the root directory to your actual backend interface address

2. Run the following commands at the root directory, then copy the files in thedistfolder to the root directory of your website service

[Reference](https://cn.vitejs.dev/guide/static-deploy.html#building-the-app)

pnpm build

FAQ

Q: Why doesGitcommit always report errors?

A: Because there is a commit message verification, please follow theCommit Guide

Q: Where to change the request interface if only the front-end page is used?

A: TheVITE_GLOB_API_URLfield in the.envfile at the root directory.

Q: All files explode red when saving?

A:vscodeplease install the recommended plug-ins for the project, or manually install theEslintplug-in.

Q: No typewriter effect on the front end?

A: One possible reason is that after Nginx reverse proxy, buffer is turned on, then Nginx will try to buffer some data from the backend before sending it to the browser. Please try addingproxy_buffering off;after the reverse proxy parameter, then reload Nginx. Other web server configurations are similar.

Contributing

Please read theContributing Guidebefore contributing

Thanks to everyone who has contributed!

Acknowledgements

Thanks toJetBrainsSoftWare for providing free Open Source license for this project.

Sponsors

If you find this project helpful and can afford it, you can give me a little support. Anyway, thanks for your support~

WeChat Pay

Alipay

License

MIT © [ChenZhaoYu]