GPT Home 项目使用与配置指南

GPT Home 项目使用与配置指南

gpt-home ChatGPT at home! Basically a better Google Nest Hub or Amazon Alexa home assistant. Built on the Raspberry Pi using the OpenAI API. 项目地址: https://gitcode.com/gh_mirrors/gp/gpt-home

1. 项目目录结构及介绍

GPT Home 项目的目录结构如下：

gpt-home/
├── .github/
├── contrib/
├── screenshots/
├── src/
│   ├── .dockerignore
│   ├── .gitattributes
│   ├── .gitignore
│   ├── CONTRIBUTING.md
│   ├── Dockerfile
│   ├── LICENSE
│   ├── README.md
│   ├── schematic.fzz
│   └── settings.json
└── ...

• .github/: 存放 GitHub 的一些配置文件。
• contrib/: 包含贡献者信息和设置脚本等。
• screenshots/: 存放项目截图。
• src/: 核心源代码和配置文件所在的目录。
  • .dockerignore: 指定不应被 Docker 存入镜像的文件。
  • .gitattributes: 定义 Git 的一些行为。
  • .gitignore: 指定 Git 忽略的文件和目录。
  • CONTRIBUTING.md: 提供贡献指南。
  • Dockerfile: 用于构建 Docker 镜像的文件。
  • LICENSE: 项目许可证信息。
  • README.md: 项目说明文件。
  • schematic.fzz: 电路图文件。
  • settings.json: 项目配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 contrib/setup.sh 脚本进行的。以下是启动脚本的基本使用方法：

curl -s https://raw.githubusercontent.com/judahpaul16/gpt-home/main/contrib/setup.sh | bash -s -- --no-build

该脚本会执行以下步骤：

• 拉取最新的 Docker 镜像。
• 配置网络连接（如 Wi-Fi）。
• 设置项目所需的其它环境。

如果需要从 DockerHub 拉取最新的镜像，可以跳过构建步骤，使用 --no-build 标志。

3. 项目的配置文件介绍

项目的配置主要通过 src/settings.json 文件进行。以下是配置文件中可能需要修改的部分：

• openai_api_key: 开放 AI API 的密钥，用于调用 OpenAI 的服务。
• litellm_api_key: LiteLLM API 的密钥，如果使用其它模型，需要更新此字段。

配置文件的修改可以通过以下命令进行：

docker exec -it gpt-home bash -c "
sed -i 's/
\"openai_api_key\"
:
\"[^\"}*]\"
/
\"openai_api_key\"
:
\"YOUR_API_KEY_HERE\"
/' src/settings.json
"

请将 YOUR_API_KEY_HERE 替换为实际的 API 密钥。

确保更新配置后重新启动服务以使更改生效。

gpt-home ChatGPT at home! Basically a better Google Nest Hub or Amazon Alexa home assistant. Built on the Raspberry Pi using the OpenAI API. 项目地址: https://gitcode.com/gh_mirrors/gp/gpt-home