Skip to content

docs: 完善宝塔面板部署教程并修复链接错误 - #3360

Merged
seefs001 merged 2 commits into
QuantumNous:mainfrom
lcq225:docs/improve-bt-installation-guide
Mar 21, 2026
Merged

docs: 完善宝塔面板部署教程并修复链接错误#3360
seefs001 merged 2 commits into
QuantumNous:mainfrom
lcq225:docs/improve-bt-installation-guide

Conversation

@lcq225

@lcq225 lcq225 commented Mar 20, 2026

Copy link
Copy Markdown
Contributor

📝 变更描述 / Description

1. 完善 docs/installation/BT.md

原文件仅 2 行内容,现扩展为完整的宝塔面板部署教程(149 行),包含:

  • 前置要求(宝塔版本、系统要求、服务器配置)
  • 详细安装步骤(安装宝塔 → 安装 Docker → 安装 New API)
  • 两种安装方法(应用商店推荐 + Docker Compose)
  • 环境变量配置说明(SESSION_SECRET、CRYPTO_SECRET 等)
  • 常见问题解答(端口访问、会话失效、数据持久化、版本更新)
  • 相关链接

所有内容基于官方文档 https://docs.newapi.pro 编写,确保准确性。

2. 修复 README.zh_CN.md 链接错误

原链接 ./docs/BT.md 指向错误路径,已修正为 ./docs/installation/BT.md

🚀 变更类型 / Type of change

  • 📝 文档更新

🔗 关联任务 / Related Issue

✅ 提交前检查项 / Checklist

  • 人工确认: 内容基于官方文档编写,无 AI 灌水
  • 深度理解: 理解宝塔面板部署流程
  • 范围聚焦: 仅修改文档,无代码改动
  • 本地验证: 已验证文件内容和链接正确
  • 安全合规: 无敏感凭据

📸 运行证明 / Proof of Work

修改前后对比:

  • docs/installation/BT.md: 2 行 → 149 行
  • README.zh_CN.md: 链接修复

Summary by CodeRabbit

  • Documentation
    • Updated documentation references and reorganized deployment docs structure.
    • Expanded 宝塔面板 (Baota Panel) deployment guide: prerequisites, two deployment flows (app store and Docker Compose), environment variable requirements (SESSION_SECRET required, CRYPTO_SECRET conditional, optional DB/Redis), key-generation commands, troubleshooting (ports, sessions, persistence) and update procedures; refreshed screenshots and explicit warnings.

- 完善 docs/installation/BT.md,从 2 行扩展为完整教程
- 包含前置要求、安装步骤、配置说明、常见问题
- 修复 README.zh_CN.md 中的链接错误
- 所有内容基于官方文档 https://docs.newapi.pro 编写
@coderabbitai

coderabbitai Bot commented Mar 20, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a58b5b6b-5b0b-41d8-95eb-84b947c93cff

📥 Commits

Reviewing files that changed from the base of the PR and between cf86fe5 and e80d867.

📒 Files selected for processing (1)
  • docs/installation/BT.md
✅ Files skipped from review due to trivial changes (1)
  • docs/installation/BT.md

Walkthrough

Updated Chinese README link to the relocated 宝塔面板 documentation and replaced a one-line SESSION_SECRET note with a full 宝塔面板 deployment guide (prereqs, install options, env vars, troubleshooting, screenshots, and update steps).

Changes

Cohort / File(s) Summary
README Path Update
README.zh_CN.md
Changed the 宝塔面板(方式 3)“图文教程” link target from ./docs/BT.md to ./docs/installation/BT.md.
宝塔面板 Deployment Documentation
docs/installation/BT.md
Replaced the previous single-line reminder about SESSION_SECRET with a comprehensive 宝塔面板 Docker deployment guide: prerequisites, 宝塔/Docker install steps, two deployment flows (宝塔应用商店 and Docker Compose), required/optional env vars (including SESSION_SECRET/CRYPTO_SECRET/SQL_DSN/REDIS_CONN_STRING), key generation commands, 常见问题, update procedure, and screenshot update.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

我是小兔写文档,跳过文件夹门,
把链接搬到新地方,教程变得更完整,
环境变量写清楚,部署步骤排成行,
戳图和常见问答,运维小白也欢畅,
🐇✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the two main changes: improving the Baota panel deployment tutorial and fixing a link error in the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can use Trivy to scan for security misconfigurations and secrets in Infrastructure as Code files.

Add a .trivyignore file to your project to customize which findings Trivy reports.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/installation/BT.md (1)

56-70: Consider updating Docker Compose version.

The version: '3' is valid but somewhat dated. Modern Docker Compose supports version 3.8 or even omitting the version field entirely (using the latest Compose file format).

♻️ Optional modernization
-version: '3'
+version: '3.8'
 services:
   new-api:

Or simply omit the version field for the latest format:

-version: '3'
 services:
   new-api:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/installation/BT.md` around lines 56 - 70, Update the Docker Compose
snippet for the new-api service to use a modern Compose format: either change
the top-level version from '3' to '3.8' or remove the version field entirely to
use the latest schema; ensure the service block (new-api) and its keys (image,
container_name, restart, ports, volumes, environment) remain unchanged and still
validate with docker-compose config after the change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/installation/BT.md`:
- Line 148: Replace the broken image markdown that uses escaped brackets and a
trailing "null" with proper Markdown image syntax: change the literal "\[宝塔面板
Docker 安装\]\(https://... null)" to "![宝塔面板 Docker 安装](https://...)" — remove the
backslashes, remove the trailing `null`, and ensure the URL inside the
parentheses is a valid image URL so the image renders correctly.

---

Nitpick comments:
In `@docs/installation/BT.md`:
- Around line 56-70: Update the Docker Compose snippet for the new-api service
to use a modern Compose format: either change the top-level version from '3' to
'3.8' or remove the version field entirely to use the latest schema; ensure the
service block (new-api) and its keys (image, container_name, restart, ports,
volumes, environment) remain unchanged and still validate with docker-compose
config after the change.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 77661d42-27e3-4454-bb19-a1d537bd8486

📥 Commits

Reviewing files that changed from the base of the PR and between 42846c6 and cf86fe5.

📒 Files selected for processing (2)
  • README.zh_CN.md
  • docs/installation/BT.md

Comment thread docs/installation/BT.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@seefs001
seefs001 merged commit 3c51608 into QuantumNous:main Mar 21, 2026
1 check passed
@seefs001

Copy link
Copy Markdown
Collaborator

感谢您的贡献,如果有兴趣可以帮忙完善一下官方文档的这个页面。
https://github.com/QuantumNous/new-api-docs-v1

@lcq225

lcq225 commented Mar 21, 2026

Copy link
Copy Markdown
Contributor Author

感谢您的贡献,如果有兴趣可以帮忙完善一下官方文档的这个页面。 https://github.com/QuantumNous/new-api-docs-v1

感谢邀请,我很乐意帮忙完善这个页面的文档。

RoodraNambisa added a commit to RoodraNambisa/new-api that referenced this pull request Mar 24, 2026
commit dbf900a
Author: CaIon <i@caion.me>
Date:   Wed Mar 25 00:04:01 2026 +0800

    fix: restore doubao coding plan deprecation and regex ignored models lost during conflict resolution

commit 7399e47
Author: CaIon <i@caion.me>
Date:   Tue Mar 24 23:56:10 2026 +0800

    feat: add slide-in animations and update translations for new UI elements

    # Conflicts:
    #	web/src/components/table/channels/modals/EditChannelModal.jsx

commit a5e2026
Author: CaIon <i@caion.me>
Date:   Tue Mar 24 23:53:50 2026 +0800

    security: harden Docker and release CI workflows

    - Pin all GitHub Actions to commit SHA to prevent supply chain attacks
    - Enable SLSA provenance attestation (mode=max) and SBOM generation
    - Add cosign keyless signing for Docker images via GitHub OIDC
    - Capture and output image digests to GitHub Job Summary
    - Pin Dockerfile base images to digest (bun:1, golang:1.26.1-alpine, debian:bookworm-slim)
    - Add SHA256 checksum generation for binary releases (Linux/macOS/Windows)
    - Update actions/checkout v3->v4, actions/setup-go v3->v5 in release.yml

commit 9ae9040
Merge: 0191a68 ded4a12
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 15:04:06 2026 +0800

    Merge pull request QuantumNous#3401 from seefs001/fix/convert-openai-detail-field

    fix: the "detail" field is empty, an empty field was sent to upstream

commit 0191a68
Merge: 16221f8 9ecad90
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 15:03:57 2026 +0800

    Merge pull request QuantumNous#3400 from seefs001/fix/openai-usage

    refactor: optimize billing flow for OpenAI-to-Anthropic convert

commit 16221f8
Merge: 763c3ff 929b506
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 15:03:47 2026 +0800

    Merge pull request QuantumNous#3399 from seefs001/refactor/codex-usage

    Refactor/codex usage

commit 763c3ff
Merge: c667e47 e520977
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 15:03:36 2026 +0800

    Merge pull request QuantumNous#3331 from seefs001/fix/claude-beta-query

    fix: apply forced beta query at final upstream URL stage

commit c667e47
Merge: 216b94d b09337e
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 15:03:23 2026 +0800

    Merge pull request QuantumNous#3333 from seefs001/fix/channel-affinity-disable

    fix: honor channel affinity skip-retry when channel is disabled

commit 216b94d
Merge: 49eb533 e9f8f62
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 15:03:01 2026 +0800

    Merge pull request QuantumNous#3335 from seefs001/chore/adjuct-default-settings

    adjuct default settings

commit 49eb533
Merge: 7693eda 45f65c2
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 15:02:44 2026 +0800

    Merge pull request QuantumNous#3381 from seefs001/feature/regex-ignored-upstream-models

    feat: support regex-prefixed ignored upstream models

commit 7693eda
Merge: d6982c8 f40eb4e
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 15:02:34 2026 +0800

    Merge pull request QuantumNous#3393 from seefs001/fix/oauth-bind

    fix: oauth bind callback handling

commit ded4a12
Author: Seefs <i@seefs.me>
Date:   Mon Mar 23 15:00:20 2026 +0800

    fix: the "detail" field is empty, an empty field was sent to the upstream system.

commit d6982c8
Merge: deff59a 6c074ef
Author: Calcium-Ion <i@caion.me>
Date:   Mon Mar 23 14:53:13 2026 +0800

    Merge pull request QuantumNous#3379 from seefs001/refactor/rm-coding-plan

    fix: disable doubao coding plan selection

commit 9ecad90
Author: Seefs <i@seefs.me>
Date:   Mon Mar 23 14:22:12 2026 +0800

    refactor: optimize billing flow for OpenAI-to-Anthropic convert

commit 929b506
Author: Seefs <i@seefs.me>
Date:   Mon Mar 23 13:54:54 2026 +0800

    refactor: simplify codex account modal and collapse raw json by default

commit 755ece2
Author: Seefs <i@seefs.me>
Date:   Mon Mar 23 00:58:59 2026 +0800

    refactor: simplify codex account modal and collapse raw json by default

commit f40eb4e
Author: Seefs <i@seefs.me>
Date:   Mon Mar 23 00:48:55 2026 +0800

    fix: oauth bind callback handling

commit 45f65c2
Author: Seefs <i@seefs.me>
Date:   Sun Mar 22 15:43:03 2026 +0800

    feat: support regex-prefixed ignored upstream models

commit 6c074ef
Author: Seefs <i@seefs.me>
Date:   Sun Mar 22 15:01:09 2026 +0800

    fix: disable doubao coding plan selection

commit deff59a
Author: CaIon <i@caion.me>
Date:   Sun Mar 22 13:55:03 2026 +0800

    fix: increase StreamScannerMaxBufferMB limit and add handling for gpt-5.4-nano prefix

commit 3c51608
Merge: 4d675b4 e80d867
Author: Seefs <40468931+seefs001@users.noreply.github.com>
Date:   Sun Mar 22 00:43:13 2026 +0800

    Merge pull request QuantumNous#3360 from lcq225/docs/improve-bt-installation-guide

    docs: 完善宝塔面板部署教程并修复链接错误

commit 4d675b4
Merge: 87b426f 2c3ae32
Author: Seefs <40468931+seefs001@users.noreply.github.com>
Date:   Sun Mar 22 00:39:49 2026 +0800

    Merge pull request QuantumNous#3357 from wenyifancc/cache_llama_cpp

    feat: Add support for counting cache-hit tokens in llama.cpp

commit 87b426f
Merge: 42846c6 49db514
Author: Seefs <40468931+seefs001@users.noreply.github.com>
Date:   Sun Mar 22 00:32:01 2026 +0800

    Merge pull request QuantumNous#3369 from RedwindA/feat/logsManagement

    feat: add server log file management to performance settings

commit 49db514
Author: RedwindA <austinaosid@gmail.com>
Date:   Sat Mar 21 21:48:31 2026 +0800

    fix: align log cleanup button with other controls in the row

commit 13122aa
Author: RedwindA <austinaosid@gmail.com>
Date:   Sat Mar 21 21:11:52 2026 +0800

    fix: refresh log info on partial delete failure

commit dcd0911
Author: RedwindA <austinaosid@gmail.com>
Date:   Sat Mar 21 20:40:39 2026 +0800

    fix: log management race condition, partial delete reporting, and UX issues

    - Fix data race on gin.DefaultWriter during log rotation by adding LogWriterMu
    - Report partial failure when some log files fail to delete instead of always returning success
    - Fix misleading "logging disabled" banner shown before API responds
    - Fix en.json translation for numeric validation message

commit e904579
Author: RedwindA <austinaosid@gmail.com>
Date:   Sat Mar 21 20:06:49 2026 +0800

    feat: add server log file management to performance settings

    Add API endpoints (GET/DELETE /api/performance/logs) to list and clean up
    server log files by count or by age. Track the active log file path in
    the logger to prevent deleting the currently open log. Add a management
    UI section in the performance settings page with log directory info,
    file statistics, and cleanup controls. Includes i18n translations for
    all supported languages (en, fr, ja, ru, vi, zh-CN, zh-TW).

commit e80d867
Author: mm413 <lcq225@163.com>
Date:   Fri Mar 20 20:13:30 2026 +0800

    Update docs/installation/BT.md

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

commit cf86fe5
Author: lcq225 <lcq225@163.com>
Date:   Fri Mar 20 20:06:09 2026 +0800

    docs: 完善宝塔面板部署教程并修复链接错误

    - 完善 docs/installation/BT.md,从 2 行扩展为完整教程
    - 包含前置要求、安装步骤、配置说明、常见问题
    - 修复 README.zh_CN.md 中的链接错误
    - 所有内容基于官方文档 https://docs.newapi.pro 编写

commit 2c3ae32
Author: wenyifan <yifan.wen@eisgroup.com>
Date:   Fri Mar 20 16:48:04 2026 +0800

    fix map

commit 498199b
Author: wenyifan <yifan.wen@eisgroup.com>
Date:   Fri Mar 20 16:38:48 2026 +0800

    fix code quality

commit ff29900
Author: wenyifan <yifan.wen@eisgroup.com>
Date:   Fri Mar 20 16:10:18 2026 +0800

    feat: Add support for counting cache-hit tokens in llama.cpp OpenAI-Compatible API

commit eff5185
Author: Seefs <i@seefs.me>
Date:   Fri Mar 20 16:00:36 2026 +0800

    refactor: show codex account info tag and highlight plan type in usage modal

commit e9f8f62
Author: Seefs <i@seefs.me>
Date:   Thu Mar 19 16:58:13 2026 +0800

    fix: raise default overload disk threshold to 95%

commit 5fe8e98
Author: Seefs <i@seefs.me>
Date:   Thu Mar 19 16:56:28 2026 +0800

    fix: default codex and claude channel affinity templates to skip retry on failure

commit e520977
Author: Seefs <i@seefs.me>
Date:   Thu Mar 19 15:49:50 2026 +0800

    fix: apply forced beta query at final upstream URL stage

commit b09337e
Author: Seefs <i@seefs.me>
Date:   Wed Mar 18 16:08:31 2026 +0800

    fix: honor channel affinity skip-retry when preferred channel is disabled
VeryGoodUser1 pushed a commit to xmz-ai/new-api that referenced this pull request Apr 3, 2026
…llation-guide

docs: 完善宝塔面板部署教程并修复链接错误
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants