Feat bt doc

[weester-yan]

💻 变更类型 | Change Type

• feat
• fix
• refactor
• perf
• style
• test
• docs
• ci
• chore
• build

🔀 变更说明 | Description of Change

📝 补充信息 | Additional Information

Summary by CodeRabbit

• New Features

  • Introduced comprehensive deployment instructions for the "宝塔面板" (BT Panel) related to the ChatGPT-Next-Web project.
  • Provided a step-by-step guide for one-click installation through the BT Panel's Docker application store.

• Documentation

  • Enhanced the README with a refined introduction and overview of the NextChat application.
  • Expanded the "Enterprise Edition" section with detailed features.
  • Updated the "Features" section to include new functionalities and improvements.
  • Added a "What's New" section to highlight recent updates and versions.
  • Improved the "Get Started" and "FAQ" sections for better user guidance.
  • Expanded the environment variables section for clearer setup instructions.
  • Updated the README_CN.md with new sections and detailed deployment instructions.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nextchat	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 1, 2024 10:21am

[coderabbitai]

Walkthrough

This pull request introduces deployment instructions for the "宝塔面板" (BT Panel) in relation to the ChatGPT-Next-Web project. It includes prerequisites for installation, a step-by-step guide for one-click deployment via Docker, and configuration details for environment variables. The instructions emphasize security measures, such as setting an access password for the Open API Key and ensuring proper network settings. The document concludes with guidance on accessing the application through a web browser.

Changes

File	Change Summary
docs/bt-cn.md	Added deployment instructions for BT Panel, including prerequisites, installation steps, and configuration details.
README.md	Updated content and structure, including enhanced sections on the Enterprise Edition, features, roadmap, environment variables, and a new "What's New" section.
README_CN.md	Expanded sections for deployment instructions, environment variables, and added new subsections for clarity and security.

Possibly related PRs

• Update README.md #5722: The changes in this PR include an expanded section on the "Enterprise Edition" with detailed features, which aligns with the deployment instructions for the BT Panel in the main PR, emphasizing tailored solutions for enterprise users.
• feat: qwen #4942: This PR introduces new API integrations and handlers that may relate to the deployment instructions for the BT Panel, as both involve configurations and integrations with external services.
• doc: fix Azure docs #5033: This PR updates documentation related to deployment URLs, which could be relevant to the deployment instructions provided in the main PR.
• Add enterprise edition introduction #5052: The addition of an enterprise edition introduction in this PR complements the deployment instructions by providing context on enterprise features, which may be relevant for users deploying via the BT Panel.
• fix: [#5574] readme #5608: This PR enhances the README documentation, including sections on deployment and environment variables, which are crucial for users following the BT Panel deployment instructions in the main PR.

Suggested reviewers

• lloydzhou

🐇 In the garden, we hop and play,
With BT Panel guiding the way.
One-click installs, oh what a delight,
Open API Keys shining so bright!
Security first, as we dance and prance,
Access the app, give it a chance!
🥕✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Issues-translate-bot]

Bot detected the issue body's language is not English, translate it automatically.

---

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nextchat	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 1, 2024 9:38am

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

docs/bt-cn.md (3)

1-7: Consider expanding the prerequisites section.

While the BT Panel version requirement is clearly stated, consider adding:

• Minimum system requirements (CPU, RAM, disk space)
• Docker version requirements
• Network requirements and firewall considerations

---

8-18: Enhance installation instructions with detailed configuration guidance.

The installation steps should include:

1. A complete list of required and optional environment variables
2. Detailed proxy configuration examples for regions with OpenAI access restrictions
3. Recommended port configuration and security best practices

Consider adding this information in a table format:

| Environment Variable | Required | Description | Example |
|---------------------|----------|-------------|---------|
| OPENAI_API_KEY      | Yes      | Your OpenAI API key | sk-... |
| ACCESS_CODE         | No       | Access password | your-password |
| PROXY_URL           | No       | OpenAI API proxy | http://... |

---

20-29: Enhance access instructions with security considerations and troubleshooting.

Consider adding:

1. Instructions for setting up HTTPS/SSL for secure access
2. Steps for configuring a domain name instead of using IP:port
3. Common troubleshooting steps for access issues
4. Health check endpoints or monitoring recommendations

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d66bfc6 and c2c52a1.

⛔ Files ignored due to path filters (6)

• docs/images/bt/bt-install-1.jpeg is excluded by !**/*.jpeg
• docs/images/bt/bt-install-2.jpeg is excluded by !**/*.jpeg
• docs/images/bt/bt-install-3.jpeg is excluded by !**/*.jpeg
• docs/images/bt/bt-install-4.jpeg is excluded by !**/*.jpeg
• docs/images/bt/bt-install-5.jpeg is excluded by !**/*.jpeg
• docs/images/bt/bt-install-6.jpeg is excluded by !**/*.jpeg

📒 Files selected for processing (1)

• docs/bt-cn.md (1 hunks)

🔇 Additional comments (1)

docs/bt-cn.md (1)

9-9: Verify the existence of referenced images.

Let's ensure all referenced images are present in the repository.

Also applies to: 13-13, 21-21, 24-24, 27-27, 29-29

✅ Verification successful

All referenced images are present and accessible

All six images (bt-install-1.jpeg through bt-install-6.jpeg) were found in the expected location at docs/images/bt/. The image references in the documentation are valid.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if all referenced images exist in the docs/images/bt directory

# Test: Check for the existence of each referenced image
for img in {1..6}; do
  if ! fd -t f "bt-install-${img}.jpeg" docs/images/bt/; then
    echo "Missing image: bt-install-${img}.jpeg"
  fi
done

Length of output: 581

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)

README_CN.md (3)

267-269: LGTM! Consider adding a brief overview.

The BT Panel deployment section is well-placed and properly links to detailed instructions. Consider adding a one-line description of what BT Panel is for users unfamiliar with the tool.

Add a brief description like:

 ### 宝塔面板部署
+> 宝塔面板是一个简单好用的服务器运维管理面板，本节介绍如何使用宝塔面板部署本项目。
 > [简体中文 > 如何通过宝塔一键部署](./docs/bt-cn.md)

---

267-269: Consider adding security warnings and validation patterns for API keys.

The environment variables documentation is comprehensive, but could benefit from additional security guidance:

1. Add validation patterns or format examples for API keys
2. Include security warnings about protecting API keys
3. Consider adding rate limiting recommendations

Add security notes like:

 ### `OPENAI_API_KEY` （必填项）
 
 OpanAI 密钥，你在 openai 账户页面申请的 api key，使用英文逗号隔开多个 key，这样可以随机轮询这些 key。
+
+> ⚠️ 注意：请妥善保管你的 API 密钥，不要泄露给他人。建议设置 API 密钥使用限额，以防止被滥用。

Also applies to: 32-269

---

Line range hint 32-269: Fix typo in OpenAI description.

There's a typo in the OpenAI API key description.

-OpanAI 密钥
+OpenAI 密钥

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fb2c155 and fbb7a1e.

📒 Files selected for processing (1)

• README_CN.md (1 hunks)