1、快速开始

准备 docker-compose.yml

项目中提供了一个 docker-compose.yml 示例，如果你想自定义配置，请看 配置参考部分。

你可以通过下方链接下载 docker-compose.yml 模板到本地或服务器：

https://raw.githubusercontent.com/WongSaang/chatgpt-ui/main/docker-compose.yml

也可以手动创建 docker-compose.yml 文件，然后复制下面的内容到文件中：

version: '3'
services:
  client:
    image: wongsaang/chatgpt-ui-client:latest
    container_name: chatgpt-ui-client
    environment:
      - SERVER_DOMAIN=http://backend_web_server
      - DEFAULT_LOCALE=zh
      - NUXT_PUBLIC_APP_NAME='ChatGPT UI' # APP 名称
      - NUXT_PUBLIC_TYPEWRITER=true # 是否开启 打字机 效果
      - NUXT_PUBLIC_TYPEWRITER_DELAY=50 # 打字机效果的延迟时间，单位：毫秒，默认：50
    depends_on:
      - backend_web_server
    ports:
      - '8080:80'
    networks:
      - chatgpt_ui_network
  backend_wsgi_server:
    image: wongsaang/chatgpt-ui-wsgi-server:latest
    container_name: chatgpt-ui-wsgi-server
    environment:
      - APP_DOMAIN=${APP_DOMAIN:-localhost:9000} # CSRF 白名单，在这里设置为 chatgpt-ui-web-server 的地址+端口, 默认： localhost:9000
      - SERVER_WORKERS=1 # gunicorn 的工作进程数，默认为 3
      #- DB_URL=postgres://postgres:postgrespw@localhost:49153/chatgpt # 连接外部数据库，如果不设置这个参数，则默认使用内置的 Sqlite。需要注意的是，如果不连接外部数据库，数据将在容器销毁后丢失。链接格式请看下面的 DB_URL 格式对照表
      #- OPENAI_API_PROXY=https://openai.proxy.com/v1 # https://api.openai.com/v1 的代理地址
      - DJANGO_SUPERUSER_USERNAME=admin # 默认超级用户
      - DJANGO_SUPERUSER_PASSWORD=password # 默认超级用户的密码
      - DJANGO_SUPERUSER_EMAIL=admin@example.com # 默认超级用户邮箱
      - ACCOUNT_EMAIL_VERIFICATION=none # 邮箱验证方式，可选值： none, optional, mandatory. 默认为 optional。如果你不需要验证用户的邮箱，可以设置为 none。
      # 如果您想使用电子邮件验证功能，需要配置以下参数：
    #      - EMAIL_HOST=SMTP server address
    #      - EMAIL_PORT=SMTP server port
    #      - EMAIL_HOST_USER=
    #      - EMAIL_HOST_PASSWORD=
    #      - EMAIL_USE_TLS=True
    #      - EMAIL_FROM=no-reply@example.com  #默认发件邮箱地址
    ports:
      - '8000:8000'
    networks:
      - chatgpt_ui_network
  backend_web_server:
    image: wongsaang/chatgpt-ui-web-server:latest
    container_name: chatgpt-ui-web-server
    environment:
      - BACKEND_URL=http://backend_wsgi_server:8000
    ports:
      - '9000:80'
    depends_on:
      - backend_wsgi_server
    networks:
      - chatgpt_ui_network
networks:
  chatgpt_ui_network:
    driver: bridge

启动服务

你可以自行修改配置后，运行下面的命令来启动服务。

docker-compose up --pull always -d

这个命令用于启动 Docker Compose 配置中的服务。具体的参数含义如下：

• up：启动 Docker Compose 配置中的服务。
• –pull always：每次启动服务前，都会从 Docker 镜像仓库中拉取最新版本的镜像。这样可以确保使用的镜像始终是最新的。
• -d：在后台运行服务。如果不加这个参数，服务会在当前终端窗口中运行，直到用户手动停止服务。

部署完成之后

访问 http(s)://your.domain:9000/admin 或 IP http(s)://123.123.123.123:9000/admin 登录管理面板。

默认超级用户: admin
默认密码: password

在可以开始聊天之前，您需要添加一个 OpenAI 的 API 密钥。在管理面板的设置模型中，有一个名称为 openai_api_key 的记录，将值设置为您的 API 密钥。